Skip to main content
GET
/
conversations
/
{conversation}
/
messages
List messages in a conversation
curl --request GET \
  --url https://api.example.com/conversations/{conversation}/messages
{
  "data": [
    {
      "id": 1,
      "type": "<string>",
      "conversationId": 123,
      "is_reply": true,
      "parent": null,
      "deleted": true,
      "message": "<string>",
      "date": 123,
      "edited_at": 123,
      "reactions": [
        {}
      ],
      "author": {
        "id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "name": "John Doe",
        "title": "Manager",
        "active": true,
        "avatar": {},
        "archived_at": 123,
        "participant_type": "<string>",
        "subtext": "Manager - HQ (Sales)",
        "department": {
          "id": 10,
          "name": "Sales"
        },
        "unit": {
          "id": 5,
          "name": "HQ"
        }
      },
      "files": [
        {
          "id": 1,
          "name": "document.pdf",
          "mime": "application/pdf",
          "size": 102400,
          "type": "file",
          "extension": "pdf",
          "uploaded": true,
          "processing": false,
          "height": 123,
          "width": 123,
          "source": "<string>",
          "stream": "<string>",
          "versions": {},
          "screenshot": "<unknown>",
          "date": 123,
          "created_at": 123,
          "updated_at": 123,
          "created_formatted": "<string>",
          "updated_formatted": "<string>"
        }
      ],
      "voice": {
        "id": 1,
        "processing": true,
        "extension": "mp3",
        "duration": 12.5,
        "url": "<string>"
      }
    }
  ],
  "meta": {
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

Path Parameters

conversation
integer
required

Conversation ID

Query Parameters

limit
integer
default:25

Maximum number of messages to return (default 25)

Required range: 1 <= x <= 100
starter_message_id
integer

ID of a message to load around; when provided (without cursor or query), the API returns messages before and after this message and custom cursors to continue pagination.

cursor
string

Cursor string used for pagination when not using starter_message_id flow.

query
string

Full-text search in message body; only normal messages are searched.

Response

200 - application/json

Cursor-paginated list of messages in the conversation.

data
object[]
meta
object