Skip to Content

Get addressbook object.

Returns a addressbook object in raw text/vcard format, or as JSContact JSON (RFC 9553) when requested with Accept: application/json.

openemail.addressbookObjects.get(
  identityId: string,
  addressbookId: string,
  href: string,
  options?: AddressbookObjectsGetOptions,
): ApiPromise<PimObjectJson>

It calls GET /identities/{identityId}/addressbooks/{addressbookId}/objects/{href}: Get addressbook object in the API reference.

Example

const pimObjectJson = await openemail.addressbookObjects.get(identityId, addressbookId, href)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
addressbookIdstringCollection ULID or its name slug. The path's {addressbookId}.
hrefstringThe object's href: its filename segment within the collection (e.g. 1a2b3c.ics). The path's {href}.

Options

The last argument, options, a AddressbookObjectsGetOptions, takes:

OptionTypeSent asDescription
uidstringquery uidLook up object by UID instead of href slug

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, PimObjectJson. 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
404No such object, collection, or mailbox
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

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