Get a message

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

Path parameters

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

      Additional properties are allowed.

    • author object

      Message author

      Additional properties are allowed.

    • user object

      Message user

      Additional properties are allowed.

    • reactions array[object]

      Array of reactions to the message

      Additional properties are allowed.
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/conversation/conversation_uuid/messages/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "user": {
    "name": "Gareth Thompson",
    "type": "standard",
    "uuid": "e0a41eaa-123b-4c3c-bd0b-74adb28b7fd8",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2024-11-20T13:24:01+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:01+00:00",
    "otp_pending": false,
    "current_login": "App\\Http\\Resources\\LoginResource",
    "current_account": "App\\Http\\Resources\\AccountResource",
    "two_factor_type": "sms",
    "otp_confirmed_at": "2024-11-20T13:24:01+00:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2024-11-20T13:24:01+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"
    }
  },
  "uuid": "43a36608-af99-48fe-8210-0925ab658c0e",
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "525be974-b478-4974-be2e-cce6dc0bd10b",
      "parent": "Object",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\AccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "created_at": "2024-11-20T13:24:01+00:00",
      "updated_at": "2024-11-20T13:24:01+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2024-11-20T13:24:01+00:00",
      "download_url": "https://plannr.valet/file/94d3cf79-de0b-474f-90b6-5d9b1b62a0e7/download",
      "last_modified": "2024-11-20T13:24:01+00:00",
      "original_created_at": "2024-11-20T13:24:01+00:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "677c2928-7994-4735-a7a8-12e5d42de441",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:01+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:01+00: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-11-20T13:24:01+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:01+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:01+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:01+00:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "0ea4330b-e709-45e9-94ba-dc5c00a64e30",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2024-11-20T13:24:01+00:00",
      "updated_at": "2024-11-20T13:24:01+00:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "6e914b78-da56-49c8-81fa-cd77a74bf13a"
    }
  ],
  "created_at": "2024-11-20T13:24:01+00:00",
  "deleted_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+00:00"
}