calendarObjects.list
List calendar objects.
Returns a paginated list of calendar objects, optionally filtered by time range and expanded for recurring events.
openemail.calendarObjects.list(
identityId: string,
calendarId: string,
options?: CalendarObjectsListOptions,
): PagePromise<PimObjectPage, PimObjectPageObjectsItem>It calls GET /identities/{identityId}/calendars/{calendarId}/objects: List calendar objects in the API reference.
Example
for await (const pimObjectPageObjectsItem of openemail.calendarObjects.list(identityId, calendarId)) {
// every item of every page (await the call instead for one page)
}Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
calendarId | string | Collection ULID or its name slug. The path's {calendarId}. |
Options
The last argument, options, a CalendarObjectsListOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
limit | number | query limit | Page size (default 500) |
cursor | string | query cursor | Pagination cursor from previous page |
order | ('asc' | 'desc') | query order | Sort order by creation time ('asc' or 'desc') |
fields | ('meta' | 'full' | 'json') | query fields | Fields to include: 'meta' (headers/timestamps only), 'full' (raw text body), 'json' (parsed JSCalendar/JSContact JSON) |
uid | string | query uid | Filter by exact UID |
start | number | query start | Window start (epoch seconds) |
end | number | query end | Window end (epoch seconds) |
component | ('VEVENT' | 'VTODO' | 'VJOURNAL') | query component | Component type filter |
expand | boolean | query expand | Expand recurring events into instances |
fbtype | boolean | query fbtype | With expand=true: give each instance its RFC 5545 FBTYPE (fbType), decided as RFC 4791 §7.10's table and the OWNER's own PARTSTAT decide it. Opt-in because it costs a read of the owner's addresses, which only a free-busy caller needs |
progress | ('active' | 'closed' | 'needs-action' | 'in-process' | 'completed' | 'cancelled') | query progress | Task completion filter (VTODO only, and narrows to VTODO on its own). 'active' (not completed or cancelled) and 'closed' (completed or cancelled) are exact complements, so a working list and an archive between them lose no task; the rest are JSTask's own progress values. An absent or unrecognized STATUS counts as needs-action, per RFC 5545 |
q | string | query q | Case-insensitive substring over each event's summary and location |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
It is a listing, a PagePromise. Awaited, it is one page as the API answers it, PimObjectPage. Iterated with for await, it is every PimObjectPageObjectsItem of every page, each page fetched as the loop reaches it.
Errors
| Status | What it means |
|---|---|
400 | expand_requires_range, search_term_too_long, or progress_requires_vtodo (progress is a task filter and cannot be combined with a non-VTODO component) |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | No such collection, or mailbox not accessible |
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
It names these types of the API, each on a page of its own: PimObjectPage, PimObjectPageObjectsItem.