Get all conversations.
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
include string
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[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[archived] string
Return with or only archived conversations for current user. Valid options are [with, only, false]. Default is set to false.
-
sort string
Field to sort by. Valid fields are [created_at, name, latest_message, pinned_conversations]. Negative sign to denote DESC. Defaults to 'latest_message'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET /api/v1/conversation
curl \
-X GET https://api.plannrcrm.com/api/v1/conversation \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "ae600a9b-334b-4bc0-9147-7435f4d65625",
"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",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"completed_at": "2024-10-16T11:10:14+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "ef8cc548-8fc9-42ad-83df-649c5484dcfe",
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "1dbae20c-d0a8-4291-9333-755a277aae0e",
"colour": "#ef4582",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00"
}
],
"uuid": "b72dc168-92e1-4d4f-8621-e5c5082aa3a1",
"pinned": true,
"is_admin": false,
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "835f9596-b72a-450c-ada3-9abd74f4bbff",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-10-16T11:10:14+01:00",
"first_name": "Gareth",
"updated_at": "2024-10-16T11:10:14+01:00",
"with_login": true,
"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": "2024-10-16T11:10:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-10-16T11:10:14+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-10-16T11:10:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-10-16T11:10:14+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "dcc47ea2-19a1-4cc4-b735-4d9db08cbb3d",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2024-10-16T11:10:14+01:00",
"deleted_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}
]
}