Skip to Content

List what was sent for one event.

Every invitation, update, cancellation and reply this identity sent for the event, and what became of each delivery: delivered, sent, being retried, refused, rejected by the remote server, or never sent and why. Owner-only.

openemail.calendarObjects.listScheduling(
  identityId: string,
  calendarId: string,
  href: string,
  options?: CalendarObjectsListSchedulingOptions,
): ApiPromise<ObjectSchedulingLog>

It calls GET /identities/{identityId}/calendars/{calendarId}/objects/{href}/scheduling: List what was sent for one event in the API reference.

Example

const objectSchedulingLog = await openemail.calendarObjects.listScheduling(identityId, calendarId, href)

Arguments

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

Options

The last argument, options, a CalendarObjectsListSchedulingOptions, takes:

OptionTypeSent asDescription
limitnumberquery limitRows, the latest ones (default and max 500)

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, ObjectSchedulingLog. 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, or not this principal's own
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: ObjectSchedulingLog.