v1

latestOpenAPI 3.0.02026-07-249301.3 MB
Calendars

Retrieve all events from a calendar

Returns a list of calendar events related to the given calendar.

get/api/v1/calendars/{calendar_id}/events

Path parameters

calendar_idstring required

The id of the calendar related to events

Query parameters

expand_recurringboolean

Filter events by type (single or occurence).

event_typestring

Filter events by event type. This parameter accepts a comma-delimited list of event type.

attendeesstring

Filter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses.

updated_afterstring

Filter events updated after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).

updated_beforestring

Filter events updated before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).

busyboolean

Filter for events with the status busy

endstring

Filter events ending before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).

startstring

Filter events starting after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).

locationstring

Filter for events matching the specified location.

ical_uidstring

Filter for events matching the specified iCal UID.

descriptionstring

Filter for events matching the specified description.

titlestring

Filter for events matching the specified title.

is_cancelledboolean

Indicates if you want to retrieve the cancelled events.

cursorstring

A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.

offsetnumber

An offset used for pagination, if supported by the provider, else use cursor.

limitnumber

The limit of items to be returned.

account_idstring required

The id of the account to use.

Response

OK

next_cursorstring

Cursor to get the next page of results if supported. Else use offset.