Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

A bearer token obtained through one of the two flows below.

Path Parameters

conversationId
string
required

Query Parameters

page[after]
string

The cursor from the previous page's links.next. Do not build it yourself, and do not hold on to it: follow the link until there is no next.

page[limit]
integer
default:25

How many to return. Up to 50; more than that is refused rather than quietly trimmed. The same everywhere in this API.

Required range: 1 <= x <= 50
include
enum<string>

attachments — the files hanging off a message.

Available options:
attachments
sort
enum<string>

createdAt, prefixed with - for descending. Oldest first by default.

Available options:
createdAt,
-createdAt

Response

A page of messages.

data
object[]
required
included
object[]

Present when the answer is a page.

meta
object

page when the answer is a page: from, to, perPage and hasMore for a cursor (from and to are cursors, not numbers), or currentPage, from, lastPage, perPage, to and total for numbered pages. Some lists add their own beside it, such as statusCounts, unread or facets.