Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

A previously returned ETag. Authentication and the current read run before a 304 is considered.

Path Parameters

id
string<uuid>
required

Public id of a conversation the member can see.

Query Parameters

preview
boolean
default:false

When true, read without marking the conversation read.

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. A malformed, tampered or expired cursor returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

A page of messages.

A page of messages.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.