Skip to main content
GET
List scheduled emails

Authorizations

Authorization
string
header
required

An API key created in the dashboard, sent as Authorization: Bearer mk_....

Query Parameters

status
enum<string>[]

Filter by status. Repeatable, or comma-separated. A sent (dispatched) email has left this collection, so sent is not a filterable value; passing it, or any unrecognized value, returns validation_error (422).

Available options:
scheduled,
canceled,
failed
batch_id
string

Filter to a single batch grouping label.

Maximum string length: 64
scheduled_at_gte
string<date-time>

Only emails scheduled at or after this ISO-8601 instant. A timezone offset is required. The list is bounded to a 31-day window around now: an earlier bound is accepted and simply clipped, but a bound after the end of that window can never match and returns validation_error (422).

scheduled_at_lte
string<date-time>

Only emails scheduled at or before this ISO-8601 instant. A timezone offset is required. The list is bounded to a 31-day window around now: a later bound is accepted and simply clipped, but a bound before the start of that window can never match and returns validation_error (422).

page
integer
default:1

Page number (1-based).

Required range: x >= 1

Response

A page of scheduled emails.

One page of scheduled emails.

pagination
object
required

The page envelope.

data
object[]
required

The scheduled emails on this page.