Skip to content

Google: Watch for changes to Calendar List resources — request body — query

Watch for changes to CalendarList resources.: request body, field query. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Watch for changes to Calendar List resources — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldsstringOptionalSelector specifying which fields to include in a partial response.
prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
quotaUserstringOptionalAn opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIpstringOptionalDeprecated. Please use quotaUser instead.
maxResultsintegerOptionalMaximum 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.
Format: int32
Minimum: 1
minAccessRolestringOptionalThe minimum access role for the user in the returned entries. Optional. The default is no restriction.
One of: freeBusyReader, owner, reader, writer, writerWithoutPrivateAccess
pageTokenstringOptionalToken specifying which result page to return. Optional.
showDeletedbooleanOptionalWhether to include deleted calendar list entries in the result. Optional. The default is False.
showHiddenbooleanOptionalWhether to show hidden entries. Optional. The default is False.
showOwnOrganizationOnlybooleanOptionalWhether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.
syncTokenstringOptionalToken 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.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.