Optional. The maximum number of subscriptions to return. The service might return fewer than this value.
If unspecified or set to 0, up to 50 subscriptions are returned.
The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.
pageToken
string
Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page.
When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
filter
string
Required. A query filter.
You can filter subscriptions by event type (event_types) and target resource (target_resource).
You must specify at least one event type in your query. To filter for multiple event types, use the OR operator.
To filter by both event type and target resource, use the AND operator and specify the full resource name, such as //chat.googleapis.com/spaces/{space}.
For example, the following queries are valid:
event_types:"google.workspace.chat.membership.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created"
event_types:"google.workspace.chat.message.v1.created" AND
target_resource="//chat.googleapis.com/spaces/{space}"
( event_types:"google.workspace.chat.membership.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created" ) AND
target_resource="//chat.googleapis.com/spaces/{space}"
The server rejects invalid queries with an INVALID_ARGUMENT error.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["Lists existing Google Workspace subscriptions, allowing retrieval of details like event types and target resources."],["Enables filtering of subscriptions by event types and target resource using query parameters, requiring at least one event type for filtering."],["Uses pagination to retrieve large lists of subscriptions, providing a `nextPageToken` for accessing subsequent pages."],["Requires specific OAuth scopes for authorization, such as `https://www.googleapis.com/auth/chat.bot` or `https://www.googleapis.com/auth/chat.spaces`, to access and manage subscriptions."],["Returns a response body containing a list of subscriptions and a token for pagination if further pages exist."]]],["This document outlines how to list Google Workspace subscriptions using a `GET` request to `https://workspaceevents.googleapis.com/v1/subscriptions`. Key parameters include `pageSize` (max 100) to limit results, `pageToken` for pagination, and a mandatory `filter` to specify event types and/or target resources using `OR` and `AND` operators. The request body is empty. The response body contains a list of `subscriptions` and an optional `nextPageToken` for subsequent pages. Specific OAuth scopes are required for authorization.\n"]]