/users/me/settings

GET

/users/me/settings

settings

Returns all user settings for the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.googleapis.com/calendar/v3/users/me/settings'

Response Example

{
  "etag": "string",
  "items": [
    {
      "etag": "string",
      "id": "string",
      "kind": "calendar#setting",
      "value": "string"
    }
  ],
  "kind": "calendar#settings",
  "nextPageToken": "string",
  "nextSyncToken": "string"
}

Request

Query Params

maxResults

integer

optional

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.

pageToken

string

optional

Token specifying which result page to return. Optional.

syncToken

string

optional

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.

Responses

🟢200Successful response

application/json

Body

etag

string

optional

Etag of the collection.

items

array[object (Setting) {4}]

optional

List of user settings.

etag

string

optional

ETag of the resource.

string

optional

The id of the user setting.

kind

string

optional

Type of the resource ("calendar#setting").

Default:

calendar#setting

value

string

optional

Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.

kind

string

optional

Type of the collection ("calendar#settings").

Default:

calendar#settings

nextPageToken

string

optional

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

nextSyncToken

string

optional

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.

/users/me/calendarList/{calendarId}

/users/me/settings/watch