Sign in

v1

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

Watch for changes to CalendarList resources.

post/users/me/calendarList/watch

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.

Request body

expirationstring int64

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

addressstring

The address where notifications are delivered for this channel.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceUristring

A version-specific identifier for the watched resource.

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Response

Successful response