Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173040119.6 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

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

A gcalendar:Events if successful, otherwise an error

summarystring

Title of the calendar. Read-only

kindstring

Type of the collection ("calendar#events")

nextPageTokenstring

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided

nextSyncTokenstring

Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided

accessRolestring

The user's access role for this calendar. Read-only. Possible values are:

  • "none" - The user has no access.
  • "freeBusyReader" - The user has read access to free/busy information.
  • "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs
descriptionstring

Description of the calendar. Read-only

timeZonestring

The time zone of the calendar. Read-only

etagstring

ETag of the collection

updatedstring date-time

Last modification time of the calendar (as a RFC3339 timestamp). Read-only