Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

API key with an sk_live_ or sk_test_ prefix.

Query Parameters

limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
cursor
string

Opaque pagination cursor from a previous response's nextCursor.

status
enum<string>

Lifecycle status of a message. scheduled is the initial status for a send with a future scheduledAt; queued is the initial status for an immediate send. canceled is terminal and reached when a scheduled or queued message is canceled before dispatch.

suppressed means the provider accepted the request but never attempted delivery — the recipient address failed validation, or was already suppressed for this sender. It is distinct from failed, which is a bounce reported by the receiving mail server.

Available options:
scheduled,
queued,
rendered,
dispatched,
sent,
delivered,
failed,
opted_out,
suppressed,
blocked,
canceled
channel
enum<string>
Available options:
email,
sms,
push,
web-push
template
string

Filter by template slug.

metadata[key]
string

Filter by metadata containment, Stripe-style. E.g. ?metadata[userId]=usr_123. Multiple keys are AND-ed. A value matches whether it was stored as a string or as a number/boolean, so ?metadata[orderId]=123 matches both "123" and 123.

tail
enum<string>

Set to 1 to receive a Server-Sent Events stream instead of JSON.

Available options:
1

Response

A page of messages.

data
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null if no more results.