Skip to Content

List domains.

Returns a paginated list of domains owned by this account with optional mailbox counts and sampled storage metrics. A SYSTEM caller lists every domain on the deployment, and may narrow to one tenant with accountId.

openemail.domains.list(
  options?: DomainsListOptions,
): PagePromise<DomainsListResult, Domain>

It calls GET /domains: List domains in the API reference.

Example

for await (const domain of openemail.domains.list()) {
  // every item of every page (await the call instead for one page)
}

Options

The last argument, options, a DomainsListOptions, takes:

OptionTypeSent asDescription
accountIdstringquery accountIdSystem callers only: list just this account's domains (ignored for account principals, which always see their own)
mailboxCountsbooleanquery mailboxCountsSet to 'true' to include mailbox counts per domain
usagebooleanquery usageSet to 'true' to include sampled storage usage metrics per domain
limitnumberquery limitPage size (default 100)
cursorstringquery cursorOpaque page cursor from a previous response

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

It is a listing, a PagePromise. Awaited, it is one page as the API answers it, DomainsListResult. Iterated with for await, it is every Domain of every page, each page fetched as the loop reaches it.

Errors

StatusWhat it means
400validation_failed
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

DomainsListResult

/** What `domains.list` answers. */
type DomainsListResult = {
  domains: Domain[]
  /** Opaque cursor for the next page; absent on the last page */
  nextCursor?: string
}

It names these types of the API, each on a page of its own: Domain.