2026-05-27
▼ ▲ health.projects.subscribers.subscriptions.create
Path : v4/{+parent}/subscriptions
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions
HTTP Method : POST
Parameters :
parent
Description : Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} 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.
Pattern : ^projects/[^/]+/subscribers/[^/]+$
Location : path
Required : Yes
Type : string
subscriptionId
Description : Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.
▼ ▲ health.projects.subscribers.subscriptions.list
Path : v4/{+parent}/subscriptions
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} 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.
Pattern : ^projects/[^/]+/subscribers/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : 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 `healthUserId` Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")
Location : query
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : 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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
▼ ▲ health.projects.subscribers.subscriptions.patch
Path : v4/{+name}
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) 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. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
Pattern : ^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the data types for an existing user subscription.
▼ ▲ health.projects.subscribers.subscriptions.delete
Path : v4/{+name}
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` 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. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.
Pattern : ^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a specific user subscription, stopping notifications for this user to this subscriber.
▼ ▲ health.users.getIrnProfile
Path : v4/{+name}
Flat Path : v4/users/{usersId}/irnProfile
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
Pattern : ^users/[^/]+/irnProfile$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/googlehealth.irn.readonly
Description : Returns user's IRN Profile details.
▼ ▲ health.users.pairedDevices.get
Path : v4/{+name}
Flat Path : v4/users/{usersId}/pairedDevices/{pairedDevicesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the device to retrieve. Format: users/{user}/devices/{device}
Pattern : ^users/[^/]+/pairedDevices/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/googlehealth.settings.readonly
Description : Returns user's Device.
▼ ▲ health.users.pairedDevices.list
Path : v4/{+parent}/pairedDevices
Flat Path : v4/users/{usersId}/pairedDevices
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of devices. Format: users/{user}
Pattern : ^users/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/googlehealth.settings.readonly
Description : Returns the user's list of paired 1P trackers and smartwatches.