Skip to Content
GET
/api/v1/domains/{domain}/forward-usage

Returns outbound email forwarding rate limit consumption (for group expansions and redirects) over the rolling 24-hour window for a domain. For an SRS bounce-return domain the isolated bounce-return budget is reported separately as srsBounce.

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

domain*string

Domain name (e.g. 'example.com')

Response Body

Current forwarding limit usage and effective limits

application/json
  1. response
burstWindowSeconds*integer

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

Formatint64
messages*integer

Number of distinct messages sent in the rolling 24-hour window, plus each accepted list post whose fan-out is still being delivered: the count the daily limit is checked against

Formatint64
messagesHour*integer

Distinct messages in the BURST window — the current hourly bucket plus the previous one, so a burst stays visible for up to an hour after it ended

Formatint64
msgsPerDay*|

Configured daily message limit (null = unlimited or unenforced)

Formatint64
msgsPerHour*|

Configured hourly (burst) message limit (null = unlimited or unenforced)

Formatint64
rcptsPerDay*|

Configured daily recipient limit (null = unlimited or unenforced)

Formatint64
rcptsPerHour*|

Configured hourly (burst) recipient limit (null = unlimited or unenforced)

Formatint64
recipients*integer

Total recipient count sent to in the rolling 24-hour window, plus the recipients an accepted list post still holds for its fan-out: the count the daily limit is checked against

Formatint64
recipientsHour*integer

Recipients in the BURST window (current + previous hourly bucket)

Formatint64
sendHold*|||

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

windowSeconds*integer

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

Formatint64
srsBounce?

The SRS bounce-return channel's own budget — present only when the domain carries the srs flag. Isolated from the forwarding budget above, because SRS-shaped mail is an unauthenticated trigger and must not be able to spend a tenant channel's allowance.

Example Request
curl -X GET 'https://api.open.email/api/v1/domains/string/forward-usage'
Example Response
{
  "burstWindowSeconds": 0,
  "messages": 0,
  "messagesHour": 0,
  "msgsPerDay": 0,
  "msgsPerHour": 0,
  "rcptsPerDay": 0,
  "rcptsPerHour": 0,
  "recipients": 0,
  "recipientsHour": 0,
  "sendHold": "disabled",
  "windowSeconds": 0,
  "srsBounce": {
    "messages": 0,
    "msgsPerDay": 0
  }
}