API reference

Provider Records

Retrieve user records
GET
Request
Response
Query Parameters
from
String
required
The start date of the query based on the user timezone; inclusive
to
String
required
The end date of the query based on the user timezone; non-inclusive
provider
Array
optional
Allowed values:health_connect; fitbit; garmin; huawei; whoop; suunto; apple; oura; polar
timezone
String
optional
The timezone to use for responses, it would convert the internal timestamp from UTC to this timezone; if you leave empty it would use the user's timezone Example: America/New_York
metrics
Array
optional
heartrate_max; heartrate_min; heartrate; heartrate_resting; hrv_rmssd; hrv_sdnn; elevation_max; elevation_min; elevation_gain; elevation_loss; ascent; descent; calories_burned_active; calories_burned_basal; calories_burned; calories_intake; steps; floors_climbed; distance; distance_walking; distance_cycling; distance_running; distance_wheelchair; distance_swimming; speed; speed_max; speed_min; air_temperature_max; air_temperature; air_temperature_min; spo2; spo2_max; spo2_min; longitude; latitude; elevation; duration_active; swimming_lengths; swimming_distance_per_stroke; sleep_efficiency; sleep_duration; sleep_duration_deep; sleep_duration_light; sleep_duration_rem; sleep_duration_awake; bedtime_duration; sleep_interruptions; sleep_duration_nap; sleep_score; sleep_breathing_rate; sleep_breathing_rate_min; sleep_breathing_rate_max; sleep_latency; wakeup_latency; cadence; cadence_min; cadence_max; pace; body_mass_index; weight; height; vo2max; body_temperature; skin_temperature; skin_temperature_max; skin_temperature_min; body_temperature_max; body_temperature_min
Header Parameters
Authorization
String
required
Provide your bearer token in the Authorization header when making requests to protected resources.
Curl
Responses
200