Skip to Content

List API keys.

Returns a paginated list of API keys without secrets. A key that finished (revoked, or lapsed past its idle window) more than 180 days ago may be omitted: finished keys are retained for the audit trail's 180-day window.

openemail.apiKeys.list(
  options?: ApiKeysListOptions,
): PagePromise<ApiKeysListResult, ApiKey>

It calls GET /api-keys: List API keys in the API reference.

Example

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

Options

The last argument, options, a ApiKeysListOptions, takes:

OptionTypeSent asDescription
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, ApiKeysListResult. Iterated with for await, it is every ApiKey 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

ApiKeysListResult

/** What `apiKeys.list` answers. */
type ApiKeysListResult = {
  apiKeys: ApiKey[]
  /** 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: ApiKey.