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

GET

events

Returns instances of the specified recurring event.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.googleapis.com/calendar/v3/calendars//events//instances'

Response Example

{
    "accessRole": "string",
    "defaultReminders": [
        {
            "method": "string",
            "minutes": 0
        }
    ],
    "description": "string",
    "etag": "string",
    "items": [
        {
            "anyoneCanAddSelf": false,
            "attachments": [
                {
                    "fileId": "string",
                    "fileUrl": "string",
                    "iconLink": "string",
                    "mimeType": "string",
                    "title": "string"
                }
            ],
            "attendees": [
                {
                    "additionalGuests": 0,
                    "comment": "string",
                    "displayName": "string",
                    "email": "string",
                    "id": "string",
                    "optional": false,
                    "organizer": true,
                    "resource": false,
                    "responseStatus": "string",
                    "self": false
                }
            ],
            "attendeesOmitted": false,
            "colorId": "string",
            "conferenceData": {
                "conferenceId": "string",
                "conferenceSolution": {
                    "iconUri": "string",
                    "key": {
                        "type": "string"
                    },
                    "name": "string"
                },
                "createRequest": {
                    "conferenceSolutionKey": {
                        "type": "string"
                    },
                    "requestId": "string",
                    "status": {
                        "statusCode": "string"
                    }
                },
                "entryPoints": [
                    {
                        "accessCode": "string",
                        "entryPointFeatures": [
                            "string"
                        ],
                        "entryPointType": "string",
                        "label": "string",
                        "meetingCode": "string",
                        "passcode": "string",
                        "password": "string",
                        "pin": "string",
                        "regionCode": "string",
                        "uri": "string"
                    }
                ],
                "notes": "string",
                "parameters": {
                    "addOnParameters": {
                        "parameters": {
                            "property1": "string",
                            "property2": "string"
                        }
                    }
                },
                "signature": "string"
            },
            "created": "2019-08-24T14:15:22Z",
            "creator": {
                "displayName": "string",
                "email": "string",
                "id": "string",
                "self": false
            },
            "description": "string",
            "end": {
                "date": "2019-08-24",
                "dateTime": "2019-08-24T14:15:22Z",
                "timeZone": "string"
            },
            "endTimeUnspecified": false,
            "etag": "string",
            "eventType": "default",
            "extendedProperties": {
                "private": {
                    "property1": "string",
                    "property2": "string"
                },
                "shared": {
                    "property1": "string",
                    "property2": "string"
                }
            },
            "gadget": {
                "display": "string",
                "height": 0,
                "iconLink": "string",
                "link": "string",
                "preferences": {
                    "property1": "string",
                    "property2": "string"
                },
                "title": "string",
                "type": "string",
                "width": 0
            },
            "guestsCanInviteOthers": true,
            "guestsCanModify": false,
            "guestsCanSeeOtherGuests": true,
            "hangoutLink": "string",
            "htmlLink": "string",
            "iCalUID": "string",
            "id": "string",
            "kind": "calendar#event",
            "location": "string",
            "locked": false,
            "organizer": {
                "displayName": "string",
                "email": "string",
                "id": "string",
                "self": false
            },
            "originalStartTime": {
                "date": "2019-08-24",
                "dateTime": "2019-08-24T14:15:22Z",
                "timeZone": "string"
            },
            "privateCopy": false,
            "recurrence": [
                "string"
            ],
            "recurringEventId": "string",
            "reminders": {
                "overrides": [
                    {
                        "method": "string",
                        "minutes": 0
                    }
                ],
                "useDefault": true
            },
            "sequence": 0,
            "source": {
                "title": "string",
                "url": "string"
            },
            "start": {
                "date": "2019-08-24",
                "dateTime": "2019-08-24T14:15:22Z",
                "timeZone": "string"
            },
            "status": "string",
            "summary": "string",
            "transparency": "opaque",
            "updated": "2019-08-24T14:15:22Z",
            "visibility": "default",
            "workingLocationProperties": {
                "customLocation": {
                    "label": "string"
                },
                "homeOffice": null,
                "officeLocation": {
                    "buildingId": "string",
                    "deskId": "string",
                    "floorId": "string",
                    "floorSectionId": "string",
                    "label": "string"
                }
            }
        }
    ],
    "kind": "calendar#events",
    "nextPageToken": "string",
    "nextSyncToken": "string",
    "summary": "string",
    "timeZone": "string",
    "updated": "2019-08-24T14:15:22Z"
}

Request

Path Params

calendarId

string

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.

eventId

string

required

Recurring event identifier.

Query Params

alwaysIncludeEmail

string

optional

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).

maxAttendees

integer

optional

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.

maxResults

integer

optional

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.

originalStart

string

optional

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

pageToken

string

optional

Token specifying which result page to return. Optional.

showDeleted

string

optional

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.

timeMax

string

optional

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.

timeMin

string

optional

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.

timeZone

string

optional

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

Responses

🟢200Successful response

application/json

Body

accessRole

string

optional

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.

defaultReminders

array[object (EventReminder) {2}]

optional

The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

method

string

optional

The method used by this reminder. Possible values are:

"email" - Reminders are sent via email.

"popup" - Reminders are sent via a UI popup.
Required when adding a reminder.

minutes

integer <int32>

optional

Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder.

description

string

optional

Description of the calendar. Read-only.

etag

string

optional

ETag of the collection.

items

array[object (Event) {40}]

optional

List of events on the calendar.

anyoneCanAddSelf

boolean

optional

Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Default:

false

attachments

array[object (EventAttachment) {5}]

optional

File attachments for the event.
In order to modify attachments the supportsAttachments request parameter should be set to true.
There can be at most 25 attachments per event,

attendees

array[object (EventAttendee) {10}]

optional

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

attendeesOmitted

boolean

optional

Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

Default:

false

colorId

string

optional

The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

conferenceData

object (ConferenceData)

optional

The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.

created

string <date-time>

optional

Creation time of the event (as a RFC3339 timestamp). Read-only.

creator

object

optional

The creator of the event. Read-only.

description

string

optional

Description of the event. Can contain HTML. Optional.

end

object (EventDateTime)

optional

The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

endTimeUnspecified

boolean

optional

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

Default:

false

etag

string

optional

ETag of the resource.

eventType

string

optional

Specific type of the event. Read-only. Possible values are:

"default" - A regular event or not further specified.

"outOfOffice" - An out-of-office event.

"focusTime" - A focus-time event.

"workingLocation" - A working location event. Developer Preview.

Default:

default

extendedProperties

object

optional

Extended properties of the event.

gadget

object

optional

A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

guestsCanInviteOthers

boolean

optional

Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

Default:

true

guestsCanModify

boolean

optional

Whether attendees other than the organizer can modify the event. Optional. The default is False.

Default:

false

guestsCanSeeOtherGuests

boolean

optional

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

Default:

true

hangoutLink

string

optional

An absolute link to the Google Hangout associated with this event. Read-only.

htmlLink

string

optional

An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUID

string

optional

Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.

string

optional

Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:

characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938

the length of the ID must be between 5 and 1024 characters

the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
If you do not specify an ID, it will be automatically generated by the server.
Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

kind

string

optional

Type of the resource ("calendar#event").

Default:

calendar#event

location

string

optional

Geographic location of the event as free-form text. Optional.

locked

boolean

optional

Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

Default:

false

organizer

object

optional

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

originalStartTime

object (EventDateTime)

optional

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.

privateCopy

boolean

optional

If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

Default:

false

recurrence

array[string]

optional

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

recurringEventId

string

optional

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

reminders

object

optional

Information about the event's reminders for the authenticated user.

sequence

integer <int32>

optional

Sequence number as per iCalendar.

source

object

optional

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

start

object (EventDateTime)

optional

The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

status

string

optional

Status of the event. Optional. Possible values are:

"confirmed" - The event is confirmed. This is the default status.

"tentative" - The event is tentatively confirmed.

"cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
A cancelled status represents two different states depending on the event type:

Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

summary

string

optional

Title of the event.

transparency

string

optional

Whether the event blocks time on the calendar. Optional. Possible values are:

"opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.

"transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Default:

opaque

updated

string <date-time>

optional

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

visibility

string

optional

Visibility of the event. Optional. Possible values are:

"default" - Uses the default visibility for events on the calendar. This is the default value.

"public" - The event is public and event details are visible to all readers of the calendar.

"private" - The event is private and only event attendees may view event details.

"confidential" - The event is private. This value is provided for compatibility reasons.

Default:

default

workingLocationProperties

object (EventWorkingLocationProperties)

optional

Developer Preview: Working Location event data. Read-only.

kind

string

optional

Type of the collection ("calendar#events").

Default:

calendar#events

nextPageToken

string

optional

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

nextSyncToken

string

optional

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.

summary

string

optional

Title of the calendar. Read-only.

timeZone

string

optional

The time zone of the calendar. Read-only.

updated

string <date-time>

optional

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

Modified at 2023-08-15 05:59:47

/calendars/{calendarId}/events/{eventId}

/calendars/{calendarId}/events/{eventId}/move