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

alwaysIncludeEmail BOOLEAN

Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False

maxAttendees INTEGER

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

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

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

pageToken STRING

Token specifying which result page to return. Optional

showDeleted BOOLEAN

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 DATE_TIME

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 DATE_TIME

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

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

accessRole STRING

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[] OBJECT

defaultReminders[].method STRING

The method used by this reminder. Possible values are:

• "email" - Reminders are sent via email.
• "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
• "popup" - Reminders are sent via a UI popup.
  Required when adding a reminder.

defaultReminders[].minutes INTEGER

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

Description of the calendar. Read-only

etag STRING

ETag of the collection

items[] OBJECT

items[].anyoneCanAddSelf BOOLEAN

Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False

items[].attachments[] OBJECT

items[].attachments[].fileId STRING

ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API

items[].attachments[].fileUrl STRING

URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment

items[].attachments[].iconLink STRING

URL link to the attachment's icon. Read-only

items[].attachments[].mimeType STRING

Internet media type (MIME type) of the attachment

items[].attachments[].title STRING

Attachment title

items[].attendees[] OBJECT

items[].attendees[].additionalGuests INTEGER

Number of additional guests. Optional. The default is 0

items[].attendees[].comment STRING

The attendee's response comment. Optional

items[].attendees[].displayName STRING

The attendee's name, if available. Optional

items[].attendees[].email STRING

The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee

items[].attendees[].id STRING

The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

items[].attendees[].optional BOOLEAN

Whether this is an optional attendee. Optional. The default is False

items[].attendees[].organizer BOOLEAN

Whether the attendee is the organizer of the event. Read-only. The default is False

items[].attendees[].resource BOOLEAN

Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False

items[].attendees[].responseStatus STRING

The attendee's response status. Possible values are:

• "needsAction" - The attendee has not responded to the invitation.
• "declined" - The attendee has declined the invitation.
• "tentative" - The attendee has tentatively accepted the invitation.
• "accepted" - The attendee has accepted the invitation.

items[].attendees[].self BOOLEAN

Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False

items[].attendeesOmitted BOOLEAN

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

items[].colorId STRING

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

items[].conferenceData OBJECT

items[].conferenceData.conferenceId STRING

The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:

• "eventHangout": unset.
• "eventNamedHangout": the name of the Hangout.
• "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.

items[].conferenceData.conferenceSolution OBJECT

items[].conferenceData.conferenceSolution.iconUri STRING

The user-visible icon for this solution

items[].conferenceData.conferenceSolution.name STRING

The user-visible name of this solution. Not localized

items[].conferenceData.createRequest OBJECT

items[].conferenceData.createRequest.requestId STRING

The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored

items[].conferenceData.entryPoints[] OBJECT

items[].conferenceData.notes STRING

Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional

items[].conferenceData.parameters OBJECT

items[].conferenceData.signature STRING

The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request

items[].created DATE_TIME

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

items[].creator OBJECT

The creator of the event. Read-only

items[].creator.displayName STRING

The creator's name, if available

items[].creator.email STRING

The creator's email address, if available

items[].creator.id STRING

The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

items[].creator.self BOOLEAN

Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False

items[].description STRING

Description of the event. Optional

items[].end OBJECT

items[].end.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

items[].end.dateTime DATE_TIME

The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone

items[].end.timeZone STRING

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end

items[].endTimeUnspecified BOOLEAN

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

items[].etag STRING

ETag of the resource

items[].extendedProperties OBJECT

Extended properties of the event

items[].extendedProperties.private OBJECT

Properties that are private to the copy of the event that appears on this calendar

items[].extendedProperties.private.customKey.value STRING

Properties that are private to the copy of the event that appears on this calendar

items[].extendedProperties.shared OBJECT

Properties that are shared between copies of the event on other attendees' calendars

items[].extendedProperties.shared.customKey.value STRING

Properties that are shared between copies of the event on other attendees' calendars

items[].gadget OBJECT

A gadget that extends this event

items[].gadget.display STRING

The gadget's display mode. Optional. Possible values are:

• "icon" - The gadget displays next to the event's title in the calendar view.
• "chip" - The gadget displays when the event is clicked.

items[].gadget.height INTEGER

The gadget's height in pixels. The height must be an integer greater than 0. Optional

items[].gadget.iconLink STRING

The gadget's icon URL. The URL scheme must be HTTPS

items[].gadget.link STRING

The gadget's URL. The URL scheme must be HTTPS

items[].gadget.preferences OBJECT

Preferences

items[].gadget.preferences.customKey.value STRING

Preferences

items[].gadget.title STRING

The gadget's title

items[].gadget.type STRING

The gadget's type

items[].gadget.width INTEGER

The gadget's width in pixels. The width must be an integer greater than 0. Optional

items[].guestsCanInviteOthers BOOLEAN

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

items[].guestsCanModify BOOLEAN

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

items[].guestsCanSeeOtherGuests BOOLEAN

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

items[].hangoutLink STRING

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

items[].htmlLink STRING

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

items[].iCalUID STRING

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

items[].id STRING

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.

items[].kind STRING

Type of the resource ("calendar#event")

items[].location STRING

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

items[].locked BOOLEAN

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

items[].organizer OBJECT

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

items[].organizer.displayName STRING

The organizer's name, if available

items[].organizer.email STRING

The organizer's email address, if available. It must be a valid email address as per RFC5322

items[].organizer.id STRING

The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

items[].organizer.self BOOLEAN

Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False

items[].originalStartTime OBJECT

items[].originalStartTime.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

items[].originalStartTime.dateTime DATE_TIME

The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone

items[].originalStartTime.timeZone STRING

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end

items[].privateCopy BOOLEAN

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False

items[].recurrence[] STRING

items[].recurringEventId STRING

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

items[].reminders OBJECT

Information about the event's reminders for the authenticated user

items[].reminders.overrides[] OBJECT

items[].reminders.overrides[].method STRING

The method used by this reminder. Possible values are:

• "email" - Reminders are sent via email.
• "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
• "popup" - Reminders are sent via a UI popup.
  Required when adding a reminder.

items[].reminders.overrides[].minutes INTEGER

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

items[].reminders.useDefault BOOLEAN

Whether the default reminders of the calendar apply to the event

items[].sequence INTEGER

Sequence number as per iCalendar

items[].source OBJECT

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

items[].source.title STRING

Title of the source; for example a title of a web page or an email subject

items[].source.url STRING

URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS

items[].start OBJECT

items[].start.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

items[].start.dateTime DATE_TIME

The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone

items[].start.timeZone STRING

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end

items[].status STRING

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.

items[].summary STRING

Title of the event

items[].transparency STRING

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.

items[].updated DATE_TIME

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

items[].visibility STRING

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.

kind STRING

Type of the collection ("calendar#events")

nextPageToken STRING

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

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

Title of the calendar. Read-only

timeZone STRING

The time zone of the calendar. Read-only

updated DATE_TIME

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