Get all conversations of a case

GET /api/v1/cases/{case_uuid}/conversations
Personal access token & O auth2

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, 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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/cases/{case_uuid}/conversations 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/cases/case_uuid/conversations' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "case": {
        "name": "finance",
        "slug": "finance",
        "type": "App\\Http\\Resources\\CasesTypeResource",
        "uuid": "42b5e994-6cb9-40b3-9b85-875f5573d89f",
        "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": "2025-04-02T13:27:55+01:00",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "completed_at": "2025-04-02T13:27:55+01:00",
        "participants": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "status_position": 4,
        "task_board_uuid": "02318835-7eee-4387-bcf9-bd4138d07170",
        "participants_count": 4
      },
      "name": "Welcome to Plannr",
      "slug": "welcome-to-plannr",
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "12a6a4ea-53f8-441d-b707-6644bdfadf34",
          "colour": "#ef4582",
          "created_at": "2025-04-02T13:27:55+01:00",
          "updated_at": "2025-04-02T13:27:55+01:00"
        }
      ],
      "uuid": "58a28817-ec27-403f-9323-7f3e14489e4a",
      "pinned": true,
      "is_admin": false,
      "created_at": "2025-04-02T13:27:55+01:00",
      "updated_at": "2025-04-02T13:27:55+01:00",
      "files_count": 2,
      "participants": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Gareth Thompson",
          "role": "client",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "client",
          "uuid": "c1281bea-6d60-4a73-a42c-a61d254ef9c1",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "last_name": "Thompson",
          "created_at": "2025-04-02T13:27:55+01:00",
          "first_name": "Gareth",
          "updated_at": "2025-04-02T13:27:55+01:00",
          "with_login": true,
          "inactive_at": "2025-04-02",
          "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-04-02T13:27:55+01:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2025-04-02T13:27:55+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-04-02T13:27:55+01:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2025-04-02T13:27:55+01:00"
        }
      ],
      "latest_message": {
        "user": "App\\Http\\Resources\\UserResource",
        "uuid": "817ea4e4-ff0e-4ded-b2da-c60774820b36",
        "files": "App\\Http\\Resources\\FileResource",
        "author": "App\\Http\\Resources\\AccountResource",
        "edited": true,
        "contents": "Welcome to Plannr!",
        "reactions": "App\\Http\\Resources\\ReactionResource",
        "created_at": "2025-04-02T13:27:55+01:00",
        "deleted_at": "2025-04-02T13:27:55+01:00",
        "updated_at": "2025-04-02T13:27:55+01:00"
      },
      "messages_count": 30,
      "belongs_to_case": true,
      "participants_count": 3
    }
  ]
}