Skip to Content
GET
/api/v1/accounts/{accountId}

Returns details and status for a specific 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

Account details

application/json
  1. response
activityDay*|

The UTC date (YYYY-MM-DD) of the latest recorded client activity of any identity in this account, the dormancy signal; null means no recorded activity. Show it as returned, not converted to a local timezone

Formatdate
addressCreatesPerDay*|

Addresses (routes) this account may CREATE per rolling day (null = platform default, 0 = unlimited)

Formatint64
billingTier*string

What the billing tool sold this account (system-written, PUT /accounts/:accountId/billing-tier). Not a limit: Pro's numbers are stamped only once the account is also vetted (plan = trusted); an unvetted Pro account keeps the untrusted numbers until an operator vets it

Value in"free""pro"
createdAt*integer

Creation timestamp in epoch seconds

Formatint64
deletedAt*|

Soft-deletion timestamp in epoch seconds, or null if active

Formatint64
domainCreatesPerDay*|

Domains this account may onboard per rolling day (null = platform default, 0 = unlimited)

Formatint64
forwardMsgsPerDay*|

Inbound-driven egress per rolling day — mail leaving because a route was configured, with no local sender to charge (null = platform default, 0 = unlimited). Ledger is per DOMAIN, so N domains get N x this; never spends the send allowance

Formatint64
id*string

Unique account ULID

mailboxCreatesPerDay*|

Mailboxes this account may CREATE per rolling day (null = platform default, 0 = unlimited) — a churn bound, not a ceiling; maxMailboxes is the ceiling

Formatint64
mailboxSendMsgsPerDay*|

The MAILBOX DEFAULT: messages each of this account's mailboxes may send per day when it has no override of its own (null = the platform default, 0 = unlimited)

Formatint64
mailboxSendMsgsPerHour*|

The MAILBOX DEFAULT's burst window: messages each mailbox may send per hour when it has no override of its own (null = the platform default, 0 = unlimited)

Formatint64
mailboxSendRcptsPerDay*|

The MAILBOX DEFAULT: recipients each mailbox may send to per day when it has no override of its own (null = the platform default, 0 = unlimited)

Formatint64
mailboxSendRcptsPerHour*|

The MAILBOX DEFAULT's burst window: recipients each mailbox may send to per hour when it has no override of its own (null = the platform default, 0 = unlimited)

Formatint64
maxMailTemplates*|

Stored mail templates this account may hold (null = the platform default, MAX_MAIL_TEMPLATES_DEFAULT; 0 = unlimited)

Formatint64
maxMailboxes*|

Maximum allowed mailboxes (null = the platform default, MAX_MAILBOXES_DEFAULT)

Formatint64
name*string

Account name

noticeLanguage*|

The language platform mail to a recipient with no identity here is written in (BCP 47, lowercased; null = English)

noticeMailboxId*|

Mailbox that receives limit notices as local postmaster mail (null = console-only)

plan*|

The service-class label last applied via POST /accounts/:accountId/plan (display/billing only — enforcement reads the limit columns; null = no plan recorded)

purgeAt*|

Scheduled permanent purge timestamp in epoch seconds, or null

Formatint64
purgedAt*|

Permanent purge completion timestamp in epoch seconds, or null

Formatint64
recoverySelfService*boolean

True if mailbox users in this account may recover their own password (recovery codes, and the recovery address once it ships). False is the admin_only policy: existing addresses and codes are KEPT and refused, and resets come from an admin. Written by the tenant via PUT /accounts/:accountId/recovery-policy

recvBytesPerDay*|

Daily inbound byte allowance across the account (null = platform default, 0 = unlimited)

Formatint64
recvMsgsPerDay*|

Daily inbound message allowance across the account (null = platform default, 0 = unlimited); a backstop — over it inbound is deferred, never bounced

Formatint64
retentionDays*|

The account DEFAULT time-based retention window in days, applied to every mailbox with no window of its own (null = none, the default). Outside the plan system

semantic*boolean

True if this account's mailboxes may enable SEMANTIC search (the plan gate for embedding). System-written only. Clearing it is refused 409 semantic_mailboxes_opted_in while any mailbox is opted in — paid with vectors does not become free; the tenant opts out (which deletes the embeddings) or the account is deleted (which wipes them). Once none is opted in, clearing stops new opt-ins and darkens the semantic read routes (409 semantic_not_enabled)

sendHold*|||

Operator enforcement over every mailbox on every domain this account owns: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither

sendMsgsPerDay*|

Daily outbound message limit (null = platform default, 0 = unlimited)

Formatint64
sendMsgsPerHour*|

Hourly (burst) outbound message limit (null = platform default, 0 = unlimited)

Formatint64
sendRcptsPerDay*|

Daily outbound recipient limit (null = platform default, 0 = unlimited)

Formatint64
sendRcptsPerHour*|

Hourly (burst) outbound recipient limit (null = platform default, 0 = unlimited)

Formatint64
storageLimitBytes*|

Account storage limit in bytes (null = platform default, 0 = unlimited)

Formatint64
vanityHosts*boolean

True if account is permitted to configure custom vanity hostnames

verificationToken*|

DNS TXT verification token for claiming domains

verifiedRecipientsOnly*boolean

True while the account may send only to its VERIFIED RECIPIENTS (GET /accounts/:accountId/verified-recipients): addresses on its own domains, and outside addresses whose owners confirmed them; any other outside recipient is refused 403 recipient_not_verified, that recipient alone. Stamped by the vetting label (untrusted on, trusted off; system-written, POST /accounts/:accountId/plan); false for an account never vetted either way

Example Request
curl -X GET 'https://api.open.email/api/v1/accounts/string'
Example Response
{  "activityDay": "2019-08-24",  "addressCreatesPerDay": 0,  "billingTier": "free",  "createdAt": 0,  "deletedAt": 0,  "domainCreatesPerDay": 0,  "forwardMsgsPerDay": 0,  "id": "string",  "mailboxCreatesPerDay": 0,  "mailboxSendMsgsPerDay": 0,  "mailboxSendMsgsPerHour": 0,  "mailboxSendRcptsPerDay": 0,  "mailboxSendRcptsPerHour": 0,  "maxMailTemplates": 0,  "maxMailboxes": 0,  "name": "string",  "noticeLanguage": "string",  "noticeMailboxId": "string",  "plan": "string",  "purgeAt": 0,  "purgedAt": 0,  "recoverySelfService": true,  "recvBytesPerDay": 0,  "recvMsgsPerDay": 0,  "retentionDays": 0,  "semantic": true,  "sendHold": "disabled",  "sendMsgsPerDay": 0,  "sendMsgsPerHour": 0,  "sendRcptsPerDay": 0,  "sendRcptsPerHour": 0,  "storageLimitBytes": 0,  "vanityHosts": true,  "verificationToken": "string",  "verifiedRecipientsOnly": true}