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

Returns scheduled email sends for this mailbox. By default lists pending sends; pass state to view historical or completed scheduled sends.

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

Query Parameters

state?string

Filter by state ('pending', 'releasing', 'sent', 'failed', 'canceled')

Value in"pending""releasing""sent""failed""canceled"
limit?integer

Page size (default 100)

Range1 <= value <= 200
cursor?string

Opaque page cursor from a previous response

Response Body

List of scheduled sends

application/json
  1. response
nextCursor?string

Opaque cursor for the next page; absent on the last page

scheduled*array<>
Example Request
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/scheduled'
Example Response
{
  "nextCursor": "string",
  "scheduled": [
    {
      "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"
    }
  ]
}