identities.get
Get identity and bound store usage.
Returns an identity with its bound stores (mail, calendars, contacts) and usage metrics. A bound store that cannot report its usage within a few seconds is still listed, marked unavailable: true with no counts; the rest of the identity is returned as usual.
openemail.identities.get(
identityId: string,
options?: CallOptions,
): ApiPromise<Identity>It calls GET /identities/{identityId}: Get identity and bound store usage in the API reference.
Example
const identity = await openemail.identities.get(identityId)Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Identity 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, Identity. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Identity not found or not accessible to this principal |
503 | temporary_failure: the identity's own holder could not answer its bound stores or its activity 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: Identity.