freeBusy.getMany
Free/busy for several addresses.
Busy intervals for each of the given calendar-user addresses, inside one window, asked as the identity in the path. Subjects the caller may not see — and addresses that do not exist — are reported as not visible, indistinguishably.
openemail.freeBusy.getMany(
identityId: string,
body: FreeBusyGetManyBody,
options?: CallOptions,
): ApiPromise<FreeBusyBatchResult>It calls POST /identities/{identityId}/pim/free-busy: Free/busy for several addresses in the API reference.
Example
const freeBusyBatchResult = await openemail.freeBusy.getMany(identityId, { start: 1, end: 1, addresses: ['…'] })Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Identity ULID the question is asked AS, not asked about. The path's {identityId}. |
body | FreeBusyGetManyBody | The request's body. |
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, FreeBusyBatchResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed: the window or the subject count is out of bounds |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Identity not found, or not one this credential may ask as |
413 | window_too_large: refused rather than answered partially |
503 | temporary_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
FreeBusyGetManyBody
/** The body of `freeBusy.getMany`. */
type FreeBusyGetManyBody = {
/** Calendar-user addresses, with or without a mailto: prefix */
addresses: string[]
/** Window end, unix seconds (exclusive) */
end: number
/** Window start, unix seconds */
start: number
}It names these types of the API, each on a page of its own: FreeBusyBatchResult.