v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-133839143.7 KB
events

Returns instances of the specified recurring event.

get/calendars/{calendarId}/events/{eventId}/instances

Path parameters

calendarIdstring required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

eventIdstring required

Recurring event identifier.

Query parameters

alwaysIncludeEmailboolean

Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

maxAttendeesinteger

The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

maxResultsinteger

Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

originalStartstring

The original start time of the instance in the result. Optional.

pageTokenstring

Token specifying which result page to return. Optional.

showDeletedboolean

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

timeMaxstring

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.

timeMinstring

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.

timeZonestring

Time zone used in the response. Optional. The default is the time zone of the calendar.

Response

Successful response