Get all account conversations

GET /api/v1/account/{account_uuid}/conversations

Get all conversations where the account is participating in.

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

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/account/{account_uuid}/conversations 
curl \
 -X GET https://api.plannrcrm.com/api/v1/account/account_uuid/conversations \
 -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": "367cc00a-5824-48b5-a527-7c889dc7a79b",
        "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:13+01:00",
        "updated_at": "2024-10-16T11:10:13+01:00",
        "completed_at": "2024-10-16T11:10:13+01:00",
        "participants": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "status_position": 4,
        "task_board_uuid": "0326c99f-b664-4038-9919-25e28dc1186b",
        "participants_count": 4
      },
      "name": "Welcome to Plannr",
      "slug": "welcome-to-plannr",
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "67ba6e6f-bfd2-4e74-b213-6aaa3ff4240b",
          "colour": "#ef4582",
          "created_at": "2024-10-16T11:10:13+01:00",
          "updated_at": "2024-10-16T11:10:13+01:00"
        }
      ],
      "uuid": "b3877f8a-13d8-444e-a86d-028b18cddf81",
      "pinned": true,
      "is_admin": false,
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "files_count": 2,
      "participants": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Gareth Thompson",
          "role": "client",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "client",
          "uuid": "af67de6b-07fb-444c-a2b4-093a72f61cb4",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "last_name": "Thompson",
          "created_at": "2024-10-16T11:10:13+01:00",
          "first_name": "Gareth",
          "updated_at": "2024-10-16T11:10:13+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:13+01:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2024-10-16T11:10:13+01:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "previous_review_date": "2024-10-16T11:10:13+01:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2024-10-16T11:10:13+01:00"
        }
      ],
      "latest_message": {
        "user": "App\\Http\\Resources\\UserResource",
        "uuid": "8482c490-806e-4c8a-8ebf-a15488668e93",
        "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:13+01:00",
        "deleted_at": "2024-10-16T11:10:13+01:00",
        "updated_at": "2024-10-16T11:10:13+01:00"
      },
      "messages_count": 30,
      "belongs_to_case": true,
      "participants_count": 3
    }
  ]
}