External: Health Scores

List Health Scores

Changed on

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

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

Request

  • Base URL: https://api.openwearables.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.openwearables.io/api/v1/users/{user_id}/health-scores
  • Auth: OAuth 2 (password, token URL /api/v1/auth/login)

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 cover the whole day, so a date-only range includes both boundary days.

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 cover the whole day, so a date-only range includes both boundary days.

Example:2023-11-07T05:31:56Z
category'sleep' | 'recovery' | 'readiness' | 'activity' | 'stress' | 'resilience' | 'body_battery' | 'strain'
provider'apple' | 'samsung' | 'garmin' | 'health_connect' | 'google_health' | 'polar' | 'suunto' | 'whoop' | 'strava' | 'oura' | 'fitbit' | 'ultrahuman' | 'sensorbio' | 'withings' | '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
  }
}

Changes

  • b628830d5f47Revision changes
    • breaking

      removed the enum value google from the property anyOf[subschema #1: ProviderName]/ of the query request parameter provider

    • warning

      added the new google_health enum value to the /// response property for the response status

    • warning

      added the new health_connect enum value to the /// response property for the response status

    • info

      added the enum value google_health to the property anyOf[subschema #1: ProviderName]/ of the query request parameter provider

    • info

      added the enum value health_connect to the property anyOf[subschema #1: ProviderName]/ of the query request parameter provider

    • info

      removed the google enum value from the /// response property for the response status

  • 7c7514614b91Revision changes
    • warning

      added the new withings enum value to the /// response property for the response status

    • info

      added the enum value withings to the property anyOf[subschema #1: ProviderName]/ of the query request parameter provider