GOgoogle
projects

GET /v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

Request

  • Base URL
    https://health.googleapis.com
  • URL
    https://health.googleapis.com/v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
subscribersIdstring required

Query parameters

filterstring

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - user - data_type The user identifier (e.g., user1 in users/user1) refers to the public health_user_id Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

pageSizeinteger

Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Optional. A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

Response

Successful response

nextPageTokenstring

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

Changes

No recorded changes to this operation across all 6 revisions of this API.