Method: subscriptions.list

  • 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.

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

HTTP request

GET https://workspaceevents.googleapis.com/v1/subscriptions

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

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.

Request body

The request body must be empty.

Response body

The response message for SubscriptionsService.ListSubscriptions.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Fields
subscriptions[]

object (Subscription)

List of subscriptions.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

For more information, see the Authorization guide.