Get all messages

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

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]

      Additional properties are allowed.
GET /api/v1/conversation/{conversation_uuid}/messages 
curl \
 -X GET https://api.plannrcrm.com/api/v1/conversation/conversation_uuid/messages \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "user": {
        "name": "Gareth Thompson",
        "type": "standard",
        "uuid": "59a5300a-3fdc-406d-b954-d6f7a2b1c376",
        "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": "2a5534fe-831d-4fcc-a5ac-bdc88d1c2f71",
      "files": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Welcome to Plannr",
          "size": "21691783",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "type",
          "uuid": "8aed2870-60bd-4562-9d49-d212a8cbafab",
          "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/b02cda18-8d6d-4a75-9f17-0416796070ce/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": "105ffbea-29a0-47cf-9eb0-c74f3b28777f",
        "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": "e59e393f-9eaf-448a-9a48-ba1802d7adc8",
          "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": "b9a5a36d-8623-43d0-aa90-be1d817b02b1"
        }
      ],
      "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"
    }
  ]
}