GOgoogle
settings

GET /users/me/settings

Changed on

Returns all user settings for the authenticated user.

Request

  • Base URL
    https://www.googleapis.com/calendar/v3
  • URL
    https://www.googleapis.com/calendar/v3/users/me/settings
  • 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.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
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.settings
      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.settings
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.settings.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.settings.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.

pageTokenstring

Token specifying which result page to return. Optional.

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 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#settings").

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.settings.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.settings.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.settings.readonly was removed from the endpoint's security scheme Oauth2

    • info

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