Skip to main content
GET
List calendars
Use this endpoint to discover calendar IDs before listing or retrieving calendar events. Filter by purpose to find system calendars such as the holidays or time-off calendar without matching on name.

Parameters

purpose
string
Only return calendars tagged with this purpose. Known values include holidays, leaves, anniversaries, and starting. This list is not exhaustive.
limit
number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
cursor
string
A value from a previous response that lets you fetch the next page.
starting_after
string
Return results after this calendar ID.
ending_before
string
Return results before this calendar ID.

Returns

Returns a dictionary with a calendars property that contains an array of Calendar objects. If no calendars exist, the array is empty.