Get all messages | PlannrCRM API documentation

Get all messages Run in API Explorer

GET /api/v1/conversation/{conversation_uuid}/messages

Personal access token & O auth2

Path parameters

conversation_uuid string Required

Query parameters

sort string

Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC. Defaults to '-created_at'.
per_page integer

Number of results to return with pagination (Default 30. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  The UUID of the resource.
  
  created_at string
  
  The timestamp of when the resource was created.
  
  updated_at string
  
  The timestamp of when the resource was updated.
  
  deleted_at string
  
  The timestamp of when the resource was deleted.
  
  contents string
  
  The message contents
  
  edited boolean
  
  Whether the message has been edited or not
  
  files array[object]
  
  Message file attachments
  
  Hide files attributes Show files attributes object
  
  uuid string
  
  created_at string
  
  original_created_at string
  
  updated_at string
  
  uploaded_at string
  
  status string
  
  filename string
  
  name string
  
  extension string
  
  type string
  
  size string
  
  path string
  
  last_modified string
  
  progress string
  
  download_url string
  
  folder_name string
  
  folder string
  
  documentable_type string
  
  documentable string
  
  navigator object
  
  Hide navigator attributes Show navigator attributes object
  
  model_type string
  
  model_uuid string
  
  firm string
  
  account string
  
  tags string
  
  author object
  
  Message author
  
  Hide author attributes Show author attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  custom_fields string
  
  external_references string
  
  user object
  
  Message user
  
  Hide user attributes Show user attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  current_account string
  
  current_login string
  
  two_factor_enabled boolean
  
  two_factor_type string
  
  otp_confirmed_at string
  
  otp_pending boolean
  
  sms_two_factor_enabled boolean
  
  two_factor_mobile boolean
  
  two_factor_mobile_meta object
  
  Hide two_factor_mobile_meta attributes Show two_factor_mobile_meta attributes object
  
  country string
  
  formatted string
  
  current_time_entry string
  
  session_expires_at string
  
  remember_token_expires_at boolean
  
  should_auto_save_notes boolean
  
  reactions array[object]
  
  Array of reactions to the message
  
  Hide reactions attributes Show reactions attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  account_uuid string
  
  account_name string
  
  reaction string

GET /api/v1/conversation/{conversation_uuid}/messages

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/conversation/6ff8f7f6-1eb3-3525-be4a-3932c805afed/messages' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "user": {
        "name": "Gareth Thompson",
        "type": "standard",
        "uuid": "c8383b61-d2ec-442b-bef7-65ce6d7f59c9",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-12-24T11:02:59+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-12-24T11:02:59+00:00",
        "otp_pending": false,
        "current_login": "App\\Http\\Resources\\LoginResource",
        "current_account": "App\\Http\\Resources\\AccountResource",
        "two_factor_type": "sms",
        "otp_confirmed_at": "2025-12-24T11:02:59+00:00",
        "two_factor_mobile": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "session_expires_at": "2025-12-24T11:02:59+00:00",
        "two_factor_enabled": true,
        "should_auto_save_notes": true,
        "sms_two_factor_enabled": true,
        "two_factor_mobile_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        },
        "remember_token_expires_at": true
      },
      "uuid": "453a0aad-b5cb-4195-8d62-3928118b4fb4",
      "files": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Welcome to Plannr",
          "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
          "size": "21691783",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "type",
          "uuid": "a4fa4e4b-e2ba-408a-8466-05be9e9e906e",
          "folder": "App\\Http\\Resources\\FolderResource",
          "status": "uploaded",
          "account": "App\\Http\\Resources\\MinimalAccountResource",
          "filename": "Welcome to Plannr.pdf",
          "progress": "100",
          "extension": "pdf",
          "navigator": {
            "model_type": "account",
            "model_uuid": "22b1aaaa-8b39-4b78-8af7-97e531a628f8"
          },
          "created_at": "2025-12-24T11:02:59+00:00",
          "updated_at": "2025-12-24T11:02:59+00:00",
          "folder_name": "folder 2",
          "uploaded_at": "2025-12-24T11:02:59+00:00",
          "documentable": "Object",
          "download_url": "https://api.plannrcrm.com/file/b6f1d2a8-484f-4b4d-b90e-593d2befa8d1/download",
          "last_modified": "2025-12-24T11:02:59+00:00",
          "documentable_type": "account",
          "original_created_at": "2025-12-24T11:02:59+00:00"
        }
      ],
      "author": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "d1dd7110-b6e8-405d-9c99-0817b3a00054",
        "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-12-24T11:02:59+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-12-24T11:02:59+00:00",
        "with_login": true,
        "inactive_at": "2025-12-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-12-24T11:02:59+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-12-24T11:02:59+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "last_interaction_at": "2025-12-24 11:02:59",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-12-24T11:02:59+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-12-24T11:02:59+00:00"
      },
      "edited": true,
      "contents": "Welcome to Plannr!",
      "reactions": [
        {
          "uuid": "6198b826-3c2f-4381-b335-256a07f022fb",
          "reaction": "like",
          "created_at": "2025-12-24T11:02:59+00:00",
          "updated_at": "2025-12-24T11:02:59+00:00",
          "account_name": "Gareth Thompson",
          "account_uuid": "c7c736b4-2d8a-4d46-adee-ac17c84ebd01"
        }
      ],
      "created_at": "2025-12-24T11:02:59+00:00",
      "deleted_at": "2025-12-24T11:02:59+00:00",
      "updated_at": "2025-12-24T11:02:59+00:00"
    }
  ]
}