Google: Returns a calendar from the user's calendar list — response body
Returns a calendar from the user's calendar list.: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Returns a calendar from the user's calendar list — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessRole | string | Optional | 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. - “writerWithoutPrivateAccess” - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess 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 manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. Important: the owner role is different from the calendar’s data owner. A calendar has a single data owner, but can have multiple users with owner role. |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only. |
backgroundColor | string | Optional | 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 | Optional | 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 | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
defaultReminders | array | Optional | The default reminders that the authenticated user has for this calendar. |
defaultReminders[] | Model | Each item | Expand Returns events on the specified calendar — response body — default Reminders item |
deleted | boolean | Optional | Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. Default: false |
description | string | Optional | Description of the calendar. Optional. Read-only. |
etag | string | Optional | ETag of the resource. |
foregroundColor | string | Optional | 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 | Optional | Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true. Default: false |
id | string | Optional | Identifier of the calendar. |
kind | string | Optional | Type of the resource (“calendar#calendarListEntry”). Default: calendar#calendarListEntry |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. Read-only. |
notificationSettings | object | Optional | The notifications that the authenticated user is receiving for this calendar. |
notificationSettings.notifications | array | Optional | The list of notifications set for this calendar. |
notificationSettings.notifications[] | Model | Each item | Expand Returns a calendar from the user’s calendar list — response body — notification Settings notifications item |
primary | boolean | Optional | Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. Default: false |
selected | boolean | Optional | Whether the calendar content shows up in the calendar UI. Optional. The default is False. Default: false |
summary | string | Optional | Title of the calendar. Read-only. |
summaryOverride | string | Optional | The summary that the authenticated user has set for this calendar. Optional. |
timeZone | string | Optional | The time zone of the calendar. Optional. Read-only. |
Referenced models: Returns a calendar from the user’s calendar list — response body — notification Settings notifications item, Returns metadata for a calendar — response body — conference Properties, Returns events on the specified calendar — response body — default Reminders item