Returns the calendars on the user's calendar list.
GET/users/me/calendarList
Use it in a workflow
Add a step and choose the Google Calendar connector.
Pick the Calendar.calendar List.list action (under calendarList).
Fill in the fields below, then reference the result from later steps as {{calendarCalendarListList.response.data}}.
Request
Query parameters
altstring
Data format for the response.
One ofjson
fieldsstring
Selector specifying which fields to include in a partial response.
keystring
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstring
OAuth 2.0 token for the current user.
prettyPrintboolean
Returns response with indentations and line breaks.
quotaUserstring
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIpstring
Deprecated. Please use quotaUser instead.
maxResultsinteger
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.
minAccessRolestring
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
One offreeBusyReaderownerreaderwriter
pageTokenstring
Token specifying which result page to return. Optional.
showDeletedboolean
Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHiddenboolean
Whether to show hidden entries. Optional. The default is False.
syncTokenstring
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.
Response
Returns 200 with an object. Read it in later steps with {{calendarCalendarListList.response.data.<field>}}.
etagstring
ETag of the collection.
itemsarray<object>
Calendars that are present on the user's calendar list.
accessRolestring
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.
backgroundColorstring
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.
colorIdstring
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.
conferencePropertiesobject1 fields
defaultRemindersarray<object>2 fields
The default reminders that the authenticated user has for this calendar.
deletedboolean
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
Default false
descriptionstring
Description of the calendar. Optional. Read-only.
etagstring
ETag of the resource.
foregroundColorstring
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.
hiddenboolean
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
idstring
Identifier of the calendar.
kindstring
Type of the resource ("calendar#calendarListEntry").
Default "calendar#calendarListEntry"
locationstring
Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettingsobject1 fields
The notifications that the authenticated user is receiving for this calendar.
primaryboolean
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
Default false
selectedboolean
Whether the calendar content shows up in the calendar UI. Optional. The default is False.
Default false
summarystring
Title of the calendar. Read-only.
summaryOverridestring
The summary that the authenticated user has set for this calendar. Optional.
timeZonestring
The time zone of the calendar. Optional. Read-only.
kindstring
Type of the collection ("calendar#calendarList").
Default "calendar#calendarList"
nextPageTokenstring
Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
nextSyncTokenstring
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.
