List messages
Returns messages for the authenticated workspace and environment, newest first, with cursor pagination.
Setting tail=1 switches the endpoint to a Server-Sent Events stream
(text/event-stream) that backfills the most recent 50 messages and
then pushes new ones live. Streams are closed by the server after 30
minutes; EventSource clients reconnect automatically and receive a
fresh backfill. The schemas below describe the non-streaming JSON
response.
Authorizations
API key with an sk_live_ or sk_test_ prefix.
Query Parameters
Page size (1–200).
1 <= x <= 200Opaque pagination cursor from a previous response's nextCursor.
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.
scheduled, queued, rendered, dispatched, sent, delivered, failed, opted_out, suppressed, blocked, canceled email, sms, push, web-push Filter by template slug.
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.
Set to 1 to receive a Server-Sent Events stream instead of JSON.
1