List all instances of the specified recurring event

GET {{baseUrl}}/calendars/:calId/events/:eventId/instances?maxResults=<integer>&showDeleted=<boolean>&pageToken=<string>&timeMax=<string>&timeMin=<string>&timeZone=<string>

Returns instances of the specified recurring event.

Scopes: calendar:read,calendar:read:admin

Rate Limit Label: MEDIUM

Request Params

KeyDatatypeRequiredDescription
maxResultsstringThe maximum number of events returned on one result page.
showDeletedstringWhether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
pageTokenstringThe token that specifies which result page to return. Optional.
timeMaxstringThe 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
timeMinstringThe lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
timeZonestringThe time zone in the response. Optional. The default is the time zone of the calendar.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;kind&quot;:&quot;\u003cstring\u003e&quot;,&quot;etag&quot;:&quot;\u003cstring\u003e&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;,&quot;accessRole&quot;:&quot;freeBusyReader&quot;,&quot;defaultReminders&quot;:[{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;nextPageToken&quot;:&quot;\u003cstring\u003e&quot;,&quot;items&quot;:[{&quot;end&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;,&quot;dateTime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;},&quot;start&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;,&quot;dateTime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;},&quot;attendees&quot;:[{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;additionalGuests&quot;:&quot;\u003cinteger\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;optional&quot;:&quot;\u003cboolean\u003e&quot;,&quot;resource&quot;:&quot;\u003cboolean\u003e&quot;,&quot;responseStatus&quot;:&quot;declined&quot;},{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;additionalGuests&quot;:&quot;\u003cinteger\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;optional&quot;:&quot;\u003cboolean\u003e&quot;,&quot;resource&quot;:&quot;\u003cboolean\u003e&quot;,&quot;responseStatus&quot;:&quot;needsAction&quot;}],&quot;colorId&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;guestsCanInviteOthers&quot;:&quot;\u003cboolean\u003e&quot;,&quot;guestsCanModify&quot;:&quot;\u003cboolean\u003e&quot;,&quot;guestsCanSeeOtherGuests&quot;:&quot;\u003cboolean\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;recurrence&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;reminders&quot;:{&quot;useDefault&quot;:&quot;\u003cboolean\u003e&quot;,&quot;overrides&quot;:[{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;method&quot;:&quot;email&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;}]},&quot;status&quot;:&quot;confirmed&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;transparency&quot;:&quot;transparent&quot;,&quot;visibility&quot;:&quot;private&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;creator&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;},&quot;organizer&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;},&quot;kind&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated&quot;:&quot;\u003cstring\u003e&quot;},{&quot;end&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;,&quot;dateTime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;},&quot;start&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;,&quot;dateTime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;},&quot;attendees&quot;:[{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;additionalGuests&quot;:&quot;\u003cinteger\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;optional&quot;:&quot;\u003cboolean\u003e&quot;,&quot;resource&quot;:&quot;\u003cboolean\u003e&quot;,&quot;responseStatus&quot;:&quot;tentative&quot;},{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;additionalGuests&quot;:&quot;\u003cinteger\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;optional&quot;:&quot;\u003cboolean\u003e&quot;,&quot;resource&quot;:&quot;\u003cboolean\u003e&quot;,&quot;responseStatus&quot;:&quot;needsAction&quot;}],&quot;colorId&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;guestsCanInviteOthers&quot;:&quot;\u003cboolean\u003e&quot;,&quot;guestsCanModify&quot;:&quot;\u003cboolean\u003e&quot;,&quot;guestsCanSeeOtherGuests&quot;:&quot;\u003cboolean\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;recurrence&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;reminders&quot;:{&quot;useDefault&quot;:&quot;\u003cboolean\u003e&quot;,&quot;overrides&quot;:[{&quot;method&quot;:&quot;email&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;}]},&quot;status&quot;:&quot;confirmed&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;transparency&quot;:&quot;transparent&quot;,&quot;visibility&quot;:&quot;private&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cstring\u003e&quot;,&quot;creator&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;},&quot;organizer&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;},&quot;kind&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated&quot;:&quot;\u003cstring\u003e&quot;}]}