Skip to main content
GET
Retrieve a scheduled email

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The scheduled email's id (the platform message UUID returned when it was scheduled).

Response

The scheduled email.

A scheduled email as returned by retrieve, list, and reschedule. Carries the send's metadata; the rendered body is never included.

id
string<uuid>
required

Platform message UUID.

object
string
required

Always scheduled_email.

Allowed value: "scheduled_email"
status
enum<string>
required

scheduled (awaiting send), canceled (canceled before send), sent (handed to the mail transfer agent), or failed (a due-time re-check or transport dropped it).

Available options:
scheduled,
canceled,
sent,
failed
scheduled_at
string<date-time>
required

When the message is (or was) due to send, in UTC.

message_id
string

The RFC 5322 Message-ID, in <uuid@host> form.

created_at
string<date-time>

When the send was scheduled, in UTC.

batch_id
string | null

The grouping label, or null.

subject
string

The message subject.

recipients
string

A short recipient summary: the first recipient, then +N for the overflow count. The full address list stays server-side.

Example:
topic
string | null

The mailing-list topic slug the send was attributed to, or null.

tags
object[]

The tags attached to the send.