Sign in

v3

latestOpenAPI 3.1.02026-07-31121144224.9 KB
External: Health Scores

List Health Scores

Returns health scores (sleep, recovery, readiness, etc.) for a user.

get/api/v1/users/{user_id}/health-scores

Path parameters

user_idstring uuid required

Query parameters

start_datestring date-time nullable

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_datestring date-time nullable

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'sleep' | 'recovery' | 'readiness' | 'activity' | 'stress' | 'resilience' | 'body_battery' | 'strain'
provider'apple' | 'samsung' | 'garmin' | 'google' | 'polar' | 'suunto' | 'whoop' | 'strava' | 'oura' | 'fitbit' | 'ultrahuman' | 'sensorbio' | 'unknown' | 'internal'

Supported data providers.

limitinteger
offsetinteger

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

Example response

{
  "data": [
    {
      "zone_offset": "+01:00"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTcwNDA2NzIwMH0",
    "total_count": 150
  }
}