Sign in
v1Messages

List conversation messages

Lists the messages of a conversation, newest first by default. The conversation id is the call.customerPlatformId returned by the sessions endpoints. Paginate with the returned nextCursor.

get/v1/conversations/{id}/messages

Path parameters

idnumber required

Conversation id (customerPlatformId)

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursorstring

A cursor for use in pagination. Use the nextCursor returned by the previous request.

order'asc' | 'desc'

Sort order by creation. desc returns the newest messages first.

created_at_fromstring

Only return messages created after this date.

created_at_tostring

Only return messages created before this date.

Response

nextCursorstring nullable required

Cursor for the next page. Null if there are no more results.

Example response

{
  "data": [
    {
      "id": "37826587",
      "conversationId": 1234567,
      "callId": 987654,
      "channelId": 103,
      "sender": "contact",
      "operatorId": 42,
      "operatorName": "Maria",
      "contactName": "Fulano",
      "content": "[{\"insert\":\"Olá\"}]",
      "text": "Olá",
      "media": [
        {
          "kind": "image",
          "url": "https://cdn.kinbox.com.br/media/abc.jpg"
        }
      ],
      "fileName": "contrato.pdf",
      "externalId": "wamid.HBgLNTU4NT...",
      "status": 6,
      "isSent": true,
      "viewedAt": "2026-09-14T12:00:00.000Z",
      "createdAt": "2026-09-14T11:58:00.000Z"
    }
  ]
}

Changes

Changed in 1 of the 18 revisions of this API.1