Method: admin.projects.locations.topics.subscriptions.list

Lists the subscriptions attached to the specified topic.

HTTP request

GET https://{endpoint}/v1/admin/{name=projects/*/locations/*/topics/*}/subscriptions

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the topic whose subscriptions to list.

Query parameters

Parameters
pageSize

integer

The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.

pageToken

string

A page token, received from a previous subscriptions.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to subscriptions.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response for subscriptions.list.

JSON representation
{
  "subscriptions": [
    string
  ],
  "nextPageToken": string
}
Fields
subscriptions[]

string

The names of subscriptions attached to the topic. The order of the subscriptions is unspecified.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page of results. If this field is omitted, there are no more results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.