Get a message

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

Path parameters

  • conversation_uuid string Required
  • uuid string Required

Responses

  • 200 application/json
    Hide response attributes Show response 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
      • 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
      • ownership_percentage integer
      • inactive_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
      • should_auto_save_notes boolean
    • reactions array[object]

      Array of reactions to the message

      Hide reactions attributes Show reactions attributes object
      • uuid string
      • account_uuid string
      • account_name string
      • reaction string
      • reactions string
      • created_at string
      • updated_at string
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/conversation/6ff8f7f6-1eb3-3525-be4a-3932c805afed/messages/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "user": {
    "name": "Gareth Thompson",
    "type": "standard",
    "uuid": "1453d21b-cacf-4cb1-a3c1-67111d1f69f0",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-26T11:37:05+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:05+01:00",
    "otp_pending": false,
    "current_login": "App\\Http\\Resources\\LoginResource",
    "current_account": "App\\Http\\Resources\\AccountResource",
    "two_factor_type": "sms",
    "otp_confirmed_at": "2025-06-26T11:37:05+01:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2025-06-26T11:37:05+01: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"
    }
  },
  "uuid": "013ea15f-ffe1-4d45-a084-46f9d7ce710d",
  "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": "703eec55-e759-4a3a-b239-74c3e70a5500",
      "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": "40b6c2c0-4412-4eaa-8d9c-a87e584aa557"
      },
      "created_at": "2025-06-26T11:37:05+01:00",
      "updated_at": "2025-06-26T11:37:05+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-06-26T11:37:05+01:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/0c873412-72ec-427a-bf76-644a64e58721/download",
      "last_modified": "2025-06-26T11:37:05+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-06-26T11:37:05+01:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "012176ef-f3be-4e4d-a86b-06cf62c75676",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-26T11:37:05+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:05+01:00",
    "with_login": true,
    "inactive_at": "2025-06-26",
    "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-06-26T11:37:05+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-26T11:37:05+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-06-26T11:37:05+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-26T11:37:05+01:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "63fe28c6-162f-4cc9-b2b3-ec76c10777a4",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2025-06-26T11:37:05+01:00",
      "updated_at": "2025-06-26T11:37:05+01:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "3aeffe6e-c788-4252-8cb3-df2631bba7f0"
    }
  ],
  "created_at": "2025-06-26T11:37:05+01:00",
  "deleted_at": "2025-06-26T11:37:05+01:00",
  "updated_at": "2025-06-26T11:37:05+01:00"
}