Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173040119.6 KB
calendarList

Returns the calendars on the user's calendar list.

get/users/me/calendarList

Query parameters

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

minAccessRole'freeBusyReader' | 'owner' | 'reader' | 'writer'

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

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

A gcalendar:CalendarList if successful, otherwise an error

kindstring

Type of the collection ("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

etagstring

ETag of the collection