Skip to Content
GET
/api/v1/mailboxes/{mailboxId}/scheduled/{scheduleId}

Returns the details and delivery status of a specific scheduled email send.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

scheduleId*string

Scheduled send ULID identifier

Response Body

Scheduled send details

application/json
  1. response
attempts*integer

Number of delivery attempts made

createdAt*integer

Creation timestamp in epoch seconds

Formatint64
deferrals*integer

Number of deferrals encountered

deliveryId*string

Idempotency key for this submission

error*|

Error reason if sending failed or was canceled, or null

finishedAt*|

Completion timestamp in epoch seconds, or null if pending

Formatint64
messageId*string

Draft message ULID scheduled for sending

recipients*array<string>

List of target recipient email addresses

releaseAt*integer

Actual scheduled release time in epoch seconds

Formatint64
result*array<>|

Per-recipient delivery outcomes, or null if pending

scheduleId*string

Scheduled send ULID

sendAt*integer

Requested send time in epoch seconds

Formatint64
state*string

Current scheduling status

Value in"pending""releasing""sent""failed""canceled"
threadId*|

Associated conversation thread ID, or null

Example Request
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/scheduled/string'
Example Response
{
  "attempts": 0,
  "createdAt": 0,
  "deferrals": 0,
  "deliveryId": "string",
  "error": "string",
  "finishedAt": 0,
  "messageId": "string",
  "recipients": [
    "string"
  ],
  "releaseAt": 0,
  "result": [
    {
      "address": "string",
      "deliveryId": "string",
      "error": "string",
      "list": "string",
      "pattern": "string",
      "source": "permitted_recipients",
      "status": "string"
    }
  ],
  "scheduleId": "string",
  "sendAt": 0,
  "state": "pending",
  "threadId": "string"
}