Skip to main content
GET
List calendar events in a window

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

A previously returned ETag. Authentication runs before a 304 is considered.

Query Parameters

from
string<date-time>
required

Start of the window (inclusive), ISO 8601.

to
string<date-time>
required

End of the window (exclusive), after from and at most 93 days later.

source
enum<string>
default:all

mine, company, or all (the default).

Available options:
mine,
company,
all
page[cursor]
string

Encrypted cursor from the previous page of this same from, to and source; any other window is 400.

Response

Entries in the window.

Calendar entries in the window, ordered by start time.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.