Skip to Content
GET
/api/v1/accounts/{accountId}/send-usage

Returns outbound send rate limit consumption (messages and recipients) and mailbox, address and domain creation churn over the rolling 24-hour window for an account.

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

accountId*string

Account ULID identifier

Response Body

Current window send limit usage and effective account caps

application/json
  1. response
accountId*string

Account ULID

burstWindowSeconds*integer

Width of one burst bucket in seconds (3600); the burst figures cover two of them

Formatint64
creates*
send*
sendHold*|||

The account's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither

windowSeconds*integer

Duration of the rate-limit window in seconds (e.g. 86400)

Formatint64
Example Request
curl -X GET 'https://api.open.email/api/v1/accounts/string/send-usage'
Example Response
{
  "accountId": "string",
  "burstWindowSeconds": 0,
  "creates": {
    "addresses": 0,
    "addressesPerDay": 0,
    "domains": 0,
    "domainsPerDay": 0,
    "mailboxes": 0,
    "perDay": 0
  },
  "send": {
    "messages": 0,
    "messagesHour": 0,
    "msgsPerDay": 0,
    "msgsPerHour": 0,
    "rcptsPerDay": 0,
    "rcptsPerHour": 0,
    "recipients": 0,
    "recipientsHour": 0
  },
  "sendHold": "disabled",
  "windowSeconds": 0
}