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": "a04d0f05-27ea-4753-8945-e847ff66eb82",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2025-01-17T11:18:29+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": "fb4c13ec-fe42-4d49-bde2-304c6f3578e2",
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "7b4a1cff-2172-4a8f-8ee0-9fa7bd832457",
      "parent": "Object",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\AccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-01-17T11:18:29+00:00",
      "download_url": "https://plannr.valet/file/67ceb44e-4322-43e6-be43-40eb7698ab21/download",
      "last_modified": "2025-01-17T11:18:29+00:00",
      "original_created_at": "2025-01-17T11:18:29+00:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a3f9fe72-778b-444b-b934-9e11145b398d",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:29+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:29+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:29+00:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "92213a60-9481-4b38-bb7e-843c8991fa88",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "e4b78a44-456a-4e28-a0af-2a269f1570f8"
    }
  ],
  "created_at": "2025-01-17T11:18:29+00:00",
  "deleted_at": "2025-01-17T11:18:29+00:00",
  "updated_at": "2025-01-17T11:18:29+00:00"
}