Skip to Content

Free/busy for an identity.

Busy intervals across every calendar this identity owns, inside the asked-for window. Intervals only — when, and whether the commitment is firm or tentative (RFC 5545 FBTYPE) — never event details of any kind. Readable by identities in the SAME account; refused as 404 across an account boundary.

openemail.freeBusy.get(
  identityId: string,
  options?: FreeBusyGetOptions,
): ApiPromise<FreeBusy>

It calls GET /identities/{identityId}/free-busy: Free/busy for an identity in the API reference.

Example

const freeBusy = await openemail.freeBusy.get(identityId)

Arguments

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

Options

The last argument, options, a FreeBusyGetOptions, takes:

OptionTypeSent asDescription
startnumberquery startWindow start, unix seconds
endnumberquery endWindow end, unix seconds (exclusive)

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, FreeBusy. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed: the window is missing, inverted, or too wide
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404No such identity, or not visible to this principal
413window_too_large: the window holds more calendar data than one answer can carry. REFUSED rather than answered partially — an under-reported busy list is what double-books people
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: FreeBusy.