WHOOP

App · 12 actions

Read your WHOOP profile, body measurements, cycles, sleep, workouts and recovery.

Actions

ActionWhat it does
Get body measurementsGet body measurements.
Get cycleGet cycle.
Get cycle recoveryGet cycle recovery.
Get cycle sleepGet cycle sleep.
Get profileGet profile.
Get sleepGet sleep.
Get workoutGet workout.
List cyclesList cycles.
List recoveriesList recoveries.
List sleepList sleep.
List workoutsList workouts.
Map v1 activityMap v1 activity.

Get body measurements

Get body measurements.

Inputs

None.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "height_meter": 1.0,
    "max_heart_rate": 1,
    "weight_kilogram": 1.0
  }
}

Get cycle

Get cycle.

Inputs

Cycle idcycle_idnumberRequired
ID of the cycle to retrieve

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "created_at": "example",
    "end": "example",
    "id": 1,
    "score": {
      "average_heart_rate": 1,
      "kilojoule": 1.0,
      "max_heart_rate": 1,
      "strain": 1.0
    },
    "score_state": "SCORED",
    "start": "example",
    "step_count": 1,
    "timezone_offset": "example",
    "updated_at": "example",
    "user_id": 1
  }
}

Get cycle recovery

Get cycle recovery.

Inputs

Cycle idcycle_idnumberRequired
ID of the cycle to retrieve

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "created_at": "example",
    "cycle_id": 1,
    "score": {
      "hrv_rmssd_milli": 1.0,
      "recovery_score": 1.0,
      "resting_heart_rate": 1.0,
      "skin_temp_celsius": 1.0,
      "spo2_percentage": 1.0,
      "user_calibrating": false
    },
    "score_state": "SCORED",
    "sleep_id": "example",
    "updated_at": "example",
    "user_id": 1
  }
}

Get cycle sleep

Get cycle sleep.

Inputs

Cycle idcycle_idnumberRequired
ID of the cycle to retrieve sleep for

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "created_at": "example",
    "cycle_id": 1,
    "end": "example",
    "id": "example",
    "nap": false,
    "score": {
      "respiratory_rate": 1.0,
      "sleep_consistency_percentage": 1.0,
      "sleep_efficiency_percentage": 1.0,
      "sleep_needed": {
        "baseline_milli": 1,
        "need_from_recent_nap_milli": 1,
        "need_from_recent_strain_milli": 1,
        "need_from_sleep_debt_milli": 1
      },
      "sleep_performance_percentage": 1.0,
      "stage_summary": {
        "disturbance_count": 1,
        "sleep_cycle_count": 1,
        "total_awake_time_milli": 1,
        "total_in_bed_time_milli": 1,
        "total_light_sleep_time_milli": 1,
        "total_no_data_time_milli": 1,
        "total_rem_sleep_time_milli": 1,
        "total_slow_wave_sleep_time_milli": 1
      }
    },
    "score_state": "SCORED",
    "start": "example",
    "timezone_offset": "example",
    "updated_at": "example",
    "user_id": 1,
    "v1_id": 1
  }
}

Get profile

Get profile.

Inputs

None.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "email": "example",
    "first_name": "example",
    "last_name": "example",
    "user_id": 1
  }
}

Get sleep

Get sleep.

Inputs

Sleep idsleep_idtextRequired
ID of the sleep to retrieve

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "created_at": "example",
    "cycle_id": 1,
    "end": "example",
    "id": "example",
    "nap": false,
    "score": {
      "respiratory_rate": 1.0,
      "sleep_consistency_percentage": 1.0,
      "sleep_efficiency_percentage": 1.0,
      "sleep_needed": {
        "baseline_milli": 1,
        "need_from_recent_nap_milli": 1,
        "need_from_recent_strain_milli": 1,
        "need_from_sleep_debt_milli": 1
      },
      "sleep_performance_percentage": 1.0,
      "stage_summary": {
        "disturbance_count": 1,
        "sleep_cycle_count": 1,
        "total_awake_time_milli": 1,
        "total_in_bed_time_milli": 1,
        "total_light_sleep_time_milli": 1,
        "total_no_data_time_milli": 1,
        "total_rem_sleep_time_milli": 1,
        "total_slow_wave_sleep_time_milli": 1
      }
    },
    "score_state": "SCORED",
    "start": "example",
    "timezone_offset": "example",
    "updated_at": "example",
    "user_id": 1,
    "v1_id": 1
  }
}

Get workout

Get workout.

Inputs

Workout idworkout_idtextRequired
ID of the workout to retrieve

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "created_at": "example",
    "end": "example",
    "id": "example",
    "score": {
      "altitude_change_meter": 1.0,
      "altitude_gain_meter": 1.0,
      "average_heart_rate": 1,
      "distance_meter": 1.0,
      "kilojoule": 1.0,
      "max_heart_rate": 1,
      "percent_recorded": 1.0,
      "strain": 1.0,
      "zone_durations": {
        "zone_five_milli": 1,
        "zone_four_milli": 1,
        "zone_one_milli": 1,
        "zone_three_milli": 1,
        "zone_two_milli": 1,
        "zone_zero_milli": 1
      }
    },
    "score_state": "SCORED",
    "sport_id": 1,
    "sport_name": "example",
    "start": "example",
    "timezone_offset": "example",
    "updated_at": "example",
    "user_id": 1,
    "v1_id": 1
  }
}

List cycles

List cycles.

Inputs

Limitlimitnumber
Limit on the number of cycles returnedAt most 25. Default: 10.
Startstartdate and time
Return cycles that occurred after or during (inclusive) this time. If not specified, the response will not filter cycles by a minimum time.
Endenddate and time
Return cycles that intersect this time or ended before (exclusive) this time. If not specified, `end` will be set to `now`.
Next tokennext_tokentext
Optional next token from the previous response to get the next page. If not provided, the first page in the collection is returned

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "next_token": "example",
    "records": []
  }
}

List recoveries

List recoveries.

Inputs

Limitlimitnumber
Limit on the number of recoveries returnedAt most 25. Default: 10.
Startstartdate and time
Return recoveries that occurred after or during (inclusive) this time. If not specified, the response will not filter recoveries by a minimum time.
Endenddate and time
Return recoveries that intersect this time or ended before (exclusive) this time. If not specified, `end` will be set to `now`.
Next tokennext_tokentext
Optional next token from the previous response to get the next page. If not provided, the first page in the collection is returned

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "next_token": "example",
    "records": []
  }
}

List sleep

List sleep.

Inputs

Limitlimitnumber
Limit on the number of sleeps returnedAt most 25. Default: 10.
Startstartdate and time
Return sleeps that occurred after or during (inclusive) this time. If not specified, the response will not filter sleeps by a minimum time.
Endenddate and time
Return sleeps that intersect this time or ended before (exclusive) this time. If not specified, `end` will be set to `now`.
Next tokennext_tokentext
Optional next token from the previous response to get the next page. If not provided, the first page in the collection is returned

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "next_token": "example",
    "records": []
  }
}

List workouts

List workouts.

Inputs

Limitlimitnumber
Limit on the number of workouts returnedAt most 25. Default: 10.
Startstartdate and time
Return workouts that occurred after or during (inclusive) this time. If not specified, the response will not filter workouts by a minimum time.
Endenddate and time
Return workouts that intersect this time or ended before (exclusive) this time. If not specified, `end` will be set to `now`.
Next tokennext_tokentext
Optional next token from the previous response to get the next page. If not provided, the first page in the collection is returned

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "next_token": "example",
    "records": []
  }
}

Map v1 activity

Map v1 activity.

Inputs

Activity v1 idactivity_v1_idnumberRequired
V1 Activity ID

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "v2_activity_id": "example"
  }
}

On this page