Google: Watch for changes to Events resources — request body — query

API reference · Contract 2026-10-27

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

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
alwaysIncludeEmail	boolean	Optional	Deprecated and ignored.
eventTypes	array	Optional
eventTypes[]	string	Each item	Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. One of: birthday, default, focusTime, fromGmail, outOfOffice, workingLocation
iCalUID	string	Optional	Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.
maxAttendees	integer	Optional	The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. Format: int32 Minimum: 1
maxResults	integer	Optional	Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. Default: 250 Format: int32 Minimum: 1
orderBy	string	Optional	The order of the events returned in the result. Optional. The default is an unspecified, stable order. One of: startTime, updated
pageToken	string	Optional	Token specifying which result page to return. Optional.
privateExtendedProperty	array	Optional
privateExtendedProperty[]	string	Each item	Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
q	string	Optional	Free text search terms to find events that match these terms in the following fields: - summary - description - location - attendee’s displayName - attendee’s email - organizer’s displayName - organizer’s email - workingLocationProperties.officeLocation.buildingId - workingLocationProperties.officeLocation.deskId - workingLocationProperties.officeLocation.label - workingLocationProperties.customLocation.label These search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for “Office” or “Bureau” returns working location events of type officeLocation, whereas searching for “Out of office” or “Abwesend” returns out-of-office events. Optional.
sharedExtendedProperty	array	Optional
sharedExtendedProperty[]	string	Each item	Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
showDeleted	boolean	Optional	Whether to include deleted events (with status equals “cancelled”) in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
showHiddenInvitations	boolean	Optional	Whether to include hidden invitations in the result. Optional. The default is False.
singleEvents	boolean	Optional	Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. 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.
timeMax	string	Optional	Upper bound (exclusive) for an event’s start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. Format: date-time
timeMin	string	Optional	Lower bound (exclusive) for an event’s end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. Format: date-time
timeZone	string	Optional	Time zone used in the response. Optional. The default is the time zone of the calendar.
updatedMin	string	Optional	Lower bound for an event’s last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. Format: date-time