maxResults INTEGER

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

minAccessRole ENUMERATION

The minimum access role for the user in the returned entries. Optional. The default is no restriction

pageToken STRING

Token specifying which result page to return. Optional

showDeleted BOOLEAN

Whether to include deleted calendar list entries in the result. Optional. The default is False

showHidden BOOLEAN

Whether to show hidden entries. Optional. The default is False

syncToken STRING

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries

etag STRING

ETag of the collection

items[] OBJECT

items[].accessRole STRING

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:

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

items[].backgroundColor STRING

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional

items[].colorId STRING

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional

items[].conferenceProperties OBJECT

items[].conferenceProperties.allowedConferenceSolutionTypes[] STRING

items[].defaultReminders[] OBJECT

items[].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.

items[].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

items[].deleted BOOLEAN

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False

items[].description STRING

Description of the calendar. Optional. Read-only

items[].etag STRING

ETag of the resource

items[].foregroundColor STRING

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional

items[].hidden BOOLEAN

Whether the calendar has been hidden from the list. Optional. The default is False

items[].id STRING

Identifier of the calendar

items[].kind STRING

Type of the resource ("calendar#calendarListEntry")

items[].location STRING

Geographic location of the calendar as free-form text. Optional. Read-only

items[].notificationSettings OBJECT

The notifications that the authenticated user is receiving for this calendar

items[].notificationSettings.notifications[] OBJECT

items[].notificationSettings.notifications[].method STRING

The method used to deliver the notification. Possible values are:

• "email" - Notifications are sent via email.
• "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information. Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
  Required when adding a notification.

items[].notificationSettings.notifications[].type STRING

The type of notification. Possible values are:

• "eventCreation" - Notification sent when a new event is put on the calendar.
• "eventChange" - Notification sent when an event is changed.
• "eventCancellation" - Notification sent when an event is cancelled.
• "eventResponse" - Notification sent when an attendee responds to the event invitation.
• "agenda" - An agenda with the events of the day (sent out in the morning).
  Required when adding a notification.

items[].primary BOOLEAN

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False

items[].selected BOOLEAN

Whether the calendar content shows up in the calendar UI. Optional. The default is False

items[].summary STRING

Title of the calendar. Read-only

items[].summaryOverride STRING

The summary that the authenticated user has set for this calendar. Optional

items[].timeZone STRING

The time zone of the calendar. Optional. Read-only

kind STRING

Type of the collection ("calendar#calendarList")

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