---
title: "GET /v4/projects/{projectsId}/subscribers"
method: GET
path: "/v4/projects/{projectsId}/subscribers"
tags: ["projects"]
---

# GET /v4/projects/{projectsId}/subscribers

`GET /v4/projects/{projectsId}/subscribers`

## Request

- Base URL: `https://health.googleapis.com`
- URL: `https://health.googleapis.com/v4/projects/{projectsId}/subscribers`
- 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`

Lists all subscribers registered within the owned Google Cloud Project.

## Path parameters

- `projectsId` string, required

## Query parameters

- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- ListSubscribersResponse: Response message for ListSubscribers.
  - `nextPageToken` string: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  - `subscribers` Subscriber[]: Subscribers from the specified project.
    - `createTime` string, google-datetime: Output only. The time at which the subscriber was created.
    - `endpointAuthorization` EndpointAuthorization: Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.
      - `secret` string: Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.
      - `secretSet` boolean: Output only. Whether the secret is set.
    - `endpointUri` string: Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.
    - `name` string: Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef
    - `state` 'STATE_UNSPECIFIED' | 'UNVERIFIED' | 'ACTIVE' | 'INACTIVE': Output only. The state of the subscriber.
    - `subscriberConfigs` SubscriberConfig[]: Optional. Configuration for the subscriber.
      - `dataTypes` string[]: Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.
      - `subscriptionCreatePolicy` 'SUBSCRIPTION_CREATE_POLICY_UNSPECIFIED' | 'AUTOMATIC' | 'MANUAL': Required. Policy for subscription creation.
    - `updateTime` string, google-datetime: Output only. The time at which the subscriber was last updated.
  - `totalSize` integer: The total number of subscribers matching the request.

---

[API](https://skmtc.dev/google/apis/health.md) - [All operations](https://skmtc.dev/google/apis/health/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/health/revisions/e0bfc8d98a6f?raw)
