List messages

Messages are returned newest first, ordered by created_at descending. There is no implicit default time window. Array-valued filters (channel, status, template_id, campaign_id) are repeatable query parameters (e.g. status=sent&status=delivered): values are OR-combined within a dimension and AND-combined across dimensions; each also accepts a single value. status_history is empty on list items — read a single message to get it.

Query Params
channel
array of objects

Keep only messages sent over one of these channels.

channel
Allowed:
status
array of objects

Keep only messages currently in one of these delivery states.

status
Allowed:
template_id
array of uuids
length between 0 and 100

Keep only messages rendered from one of these templates; up to 100 ids.

template_id
campaign_id
array of uuids
length between 0 and 100

Keep only messages sent as part of one of these campaigns; up to 100 ids.

campaign_id
string
length between 3 and 120

Case-insensitive substring filter; minimum 3 characters.

date-time

Keep only messages whose created_at is at or after this instant.

date-time

Keep only messages whose created_at is at or before this instant.

int32
1 to 1000
Defaults to 25

Page size; defaults to 25, max 1000 (larger values are rejected).

int32
≥ 0

Rows to skip before this page; defaults to 0.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json