Search + K

Command Palette

Search for a command to run...

Sign In

calendar.calendarList.watch

POST /users/me/calendarList/watch
Copy endpoint
https://www.googleapis.com/calendar/v3

Watch for changes to CalendarList resources.

Parameters

query Query Parameters

Name Type
maxResults

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.

number
minAccessRole

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

"freeBusyReader" | "owner" | "reader" | "writer"
pageToken

Token specifying which result page to return. Optional.

string
showDeleted

Whether to include deleted calendar list entries in the result. Optional. The default is False.

boolean
showHidden

Whether to show hidden entries. Optional. The default is False.

boolean
syncToken

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.

string
alt

Data format for the response.

"json"
fields

Selector specifying which fields to include in a partial response.

string
key

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.

string
oauth_token

OAuth 2.0 token for the current user.

string
prettyPrint

Returns response with indentations and line breaks.

boolean
quotaUser

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

string
userIp

Deprecated. Please use quotaUser instead.

string

Request Body

application/json
interface Channel {
address?: string;
expiration?: string;
id?: string;
kind?: string;
params?: { };
payload?: boolean;
resourceId?: string;
resourceUri?: string;
token?: string;
type?: string;
}

Responses

200 */*

Successful response

interface Channel {
address?: string;
expiration?: string;
id?: string;
kind?: string;
params?: { };
payload?: boolean;
resourceId?: string;
resourceUri?: string;
token?: string;
type?: string;
}