Skip to main content
GET
List Messages

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
size
integer
default:10

Number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string> | null

Field to sort by.

Available options:
sent_at
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
contact_id
string<uuid> | null

Filter by contact linked to the message sequence.

sequence_id
string<uuid> | null

Filter by sequence run.

channel
enum<string> | null

Filter by channel.

Available options:
EMAIL,
LINKEDIN,
CALENDAR,
MANUAL
direction
enum<string> | null

Filter by message direction.

Available options:
INBOUND,
OUTBOUND
created_at_after
string<date-time> | null

Return messages sent strictly after this timestamp.

created_at_before
string<date-time> | null

Return messages sent strictly before this timestamp.

Response

200 - application/json

Successful Response

items
MessagePublicOutput · object[]
required

Records on this page.

total_count
integer
required

Total number of records matching the query.

total_pages
integer
required

Total number of pages.

has_more
boolean
required

Whether more pages remain after the current one.