Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].
-
Filter by a comma separated list of UUIDs.
-
Return with or only archived conversations for current user. Valid options are [with, only, false]. Default is set to false.
-
Filter by a comma separated list of circle UUIDs.
-
Field to sort by. Valid fields are [created_at, updated_at, latest_message, pinned_conversations]. Negative sign to denote DESC. Defaults to 'latest_message'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/conversation
curl \
--request GET 'https://api.plannrcrm.com/api/v1/conversation' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "d32b14c7-aa36-4027-b3a0-c93657f9bd89",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "App\\Http\\Resources\\CasesStatusResource",
"review_at": "2025-06-26T11:37:05+01:00",
"created_at": "2025-06-26T11:37:05+01:00",
"updated_at": "2025-06-26T11:37:05+01:00",
"group_uuids": [
"1da359ab-70cd-4d0d-889a-7f2aaabd2552"
],
"completed_at": "2025-06-26T11:37:05+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "857cf6a3-cc29-4fc7-ba3a-89c93b48ad4f",
"assigned_to_uuids": [
"39e9ef6f-91d3-44f8-b547-03905afdb3ad"
],
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "b2d4e049-fdfb-452b-9757-2fec19a2dee1",
"colour": "#ef4582",
"created_at": "2025-06-26T11:37:05+01:00",
"updated_at": "2025-06-26T11:37:05+01:00"
}
],
"uuid": "63516f67-856c-44eb-ae1e-ddd7da627b10",
"pinned": true,
"is_admin": false,
"created_at": "2025-06-26T11:37:05+01:00",
"updated_at": "2025-06-26T11:37:05+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6f05a22e-69ff-4bd3-96ce-2b0de5e4524b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:05+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:05+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-26T11:37:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:05+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "e89dfd90-3f4a-4542-858f-573e93b2abd1",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-06-26T11:37:05+01:00",
"deleted_at": "2025-06-26T11:37:05+01:00",
"updated_at": "2025-06-26T11:37:05+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}
]
}