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": "2404d262-5bff-4916-9ea4-b886f267fdd3",
"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-10-24T10:34:18+01:00",
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00",
"group_uuids": [
"95de7746-bcf6-40db-bd3a-9cd64807fb72"
],
"completed_at": "2025-10-24T10:34:18+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "e50b48a9-b215-444d-bd31-2974a8ad2862",
"assigned_to_uuids": [
"fa6eb493-e133-4034-bcd0-ef5ba7097794"
],
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "6be803f1-4459-4402-adf6-e08e75a32ab9",
"colour": "#ef4582",
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00"
}
],
"uuid": "fa4f8808-e3f5-41df-8329-c378eb292e77",
"pinned": true,
"is_admin": false,
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6f01492c-f7d3-4e68-b1d7-fa5112afef54",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:18+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"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-10-24T10:34:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:18+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-10-24T10:34:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:18+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "9b732210-86a7-40a8-b6b4-35f6fc1a1092",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-10-24T10:34:18+01:00",
"deleted_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}
]
}