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

colorRgbFormat BOOLEAN

Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False

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.

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

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

conferenceProperties OBJECT

conferenceProperties.allowedConferenceSolutionTypes[] STRING

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

deleted BOOLEAN

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

description STRING

Description of the calendar. Optional. Read-only

etag STRING

ETag of the resource

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

hidden BOOLEAN

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

id STRING

Identifier of the calendar

kind STRING

Type of the resource ("calendar#calendarListEntry")

location STRING

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

notificationSettings OBJECT

The notifications that the authenticated user is receiving for this calendar

notificationSettings.notifications[] OBJECT

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.

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.

primary BOOLEAN

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

selected BOOLEAN

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

summary STRING

Title of the calendar. Read-only

summaryOverride STRING

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

timeZone STRING

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

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.

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

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

conferenceProperties OBJECT

conferenceProperties.allowedConferenceSolutionTypes[] STRING

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

deleted BOOLEAN

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

description STRING

Description of the calendar. Optional. Read-only

etag STRING

ETag of the resource

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

hidden BOOLEAN

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

id STRING

Identifier of the calendar

kind STRING

Type of the resource ("calendar#calendarListEntry")

location STRING

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

notificationSettings OBJECT

The notifications that the authenticated user is receiving for this calendar

notificationSettings.notifications[] OBJECT

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.

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.

primary BOOLEAN

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

selected BOOLEAN

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

summary STRING

Title of the calendar. Read-only

summaryOverride STRING

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

timeZone STRING

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