GOgoogle
calendarList

GET /users/me/calendarList

Changed on

Returns the calendars on the user's calendar list.

Request

  • Base URL
    https://www.googleapis.com/calendar/v3
  • URL
    https://www.googleapis.com/calendar/v3/users/me/calendarList
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.calendarlist
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.calendarlist
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.calendarlist.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.calendarlist.readonly
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.readonly

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' | 'writerWithoutPrivateAccess'

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.

showOwnOrganizationOnlyboolean

Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. 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 and showOwnOrganizationOnly query parameters 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

Successful response

etagstring

ETag of the collection.

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.

Changes

  • 54e6985ee63dRevision changes
    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2c

  • 66a1fabee696Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2c