Skip to main content
GET
List Health Scores

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key
string | null

Path Parameters

user_id
string<uuid>
required

Query Parameters

start_date
string<date-time> | null

ISO 8601 datetime (e.g. 2023-11-07T05:31:56Z) or Unix timestamp in seconds. Date-only strings (e.g. 2023-11-07) are also accepted and normalized to midnight UTC.

Example:

"2023-11-07T05:31:56Z"

end_date
string<date-time> | null

ISO 8601 datetime (e.g. 2023-11-07T05:31:56Z) or Unix timestamp in seconds. Date-only strings (e.g. 2023-11-07) are also accepted and normalized to midnight UTC.

Example:

"2023-11-07T05:31:56Z"

category
enum<string> | null
Available options:
sleep,
recovery,
readiness,
activity,
stress,
resilience,
body_battery,
strain
provider
enum<string> | null

Supported data providers.

Available options:
apple,
samsung,
garmin,
google,
polar,
suunto,
whoop,
strava,
oura,
fitbit,
ultrahuman,
sensorbio,
unknown,
internal
limit
integer
default:50
Required range: 1 <= x <= 1000
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

data
HealthScoreResponse · object[]
required
pagination
Pagination · object
required
metadata
TimeseriesMetadata · object
required