Method: projects.topics.subscriptions.list

Lists the names of the attached subscriptions on this topic.

HTTP request

GET https://pubsub.googleapis.com/v1/{topic}/subscriptions

Path parameters

Parameters
topic

string

Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of subscription names to return.

pageToken

string

Optional. The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior subscriptions.list call, and that the system should return the next page of data.

Request body

The request body must be empty.

Response body

Response for the subscriptions.list method.

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

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

string

Optional. The names of subscriptions attached to the topic specified in the request.

nextPageToken

string

Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.