Skip to Content

List an identity's addresses.

Returns every address routed to this identity — what it may be addressed AT, for matching an iCalendar ATTENDEE or ORGANIZER line. Distinct from /auth/verify's permittedFrom, which is the sendability contract and carries tag patterns.

openemail.identities.listAddresses(
  identityId: string,
  options?: CallOptions,
): ApiPromise<IdentityAddresses>

It calls GET /identities/{identityId}/addresses: List an identity's addresses in the API reference.

Example

const identityAddresses = await openemail.identities.listAddresses(identityId)

Arguments

ArgumentTypeDescription
identityIdstringIdentity ULID identifier. The path's {identityId}.

Options

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

Answer

Awaited, it is the API's JSON, IdentityAddresses. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Identity not found or not accessible to this principal
503temporary_failure: the identity's account could not answer its addresses just now (under the object directory); retry after the Retry-After window

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

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