WHwhoop
Cycle

GET /v2/cycle/{cycleId}/sleep

Changed on

Get the sleep for the specified cycle ID

Request

Path parameters

cycleIdinteger required

ID of the cycle to retrieve sleep for

Response

Successful request

idstring uuid required

Unique identifier for the sleep activity

cycle_idinteger required

Unique identifier for the cycle this sleep belongs to

v1_idinteger

Previous generation identifier for the activity. Will not exist past 09/01/2025

user_idinteger required

The WHOOP User who performed the sleep activity

created_atstring date-time required

The time the sleep activity was recorded in WHOOP

updated_atstring date-time required

The time the sleep activity was last updated in WHOOP

startstring date-time required

Start time bound of the sleep

endstring date-time required

End time bound of the sleep

timezone_offsetstring required

The user's timezone offset at the time the sleep was recorded. Follows format for Time Zone Designator (TZD) - '+hh:mm', '-hh:mm', or 'Z'.

napboolean required

If true, this sleep activity was a nap for the user

score_state'SCORED' | 'PENDING_SCORE' | 'UNSCORABLE' required

SCORED means the sleep activity was scored and the measurement values will be present. PENDING_SCORE means WHOOP is currently evaluating the sleep activity. UNSCORABLE means this activity could not be scored for some reason - commonly because there is not enough user metric data for the time range.

Example response

{
  "id": "ecfc6a15-4661-442f-a9a4-f160dd7afae8",
  "cycle_id": 93845,
  "v1_id": 93845,
  "user_id": 10129,
  "created_at": "2022-04-24T11:25:44.774Z",
  "updated_at": "2022-04-24T14:25:44.774Z",
  "start": "2022-04-24T02:25:44.774Z",
  "end": "2022-04-24T10:25:44.774Z",
  "timezone_offset": "-05:00",
  "score_state": "SCORED",
  "score": {
    "stage_summary": {
      "total_in_bed_time_milli": 30272735,
      "total_awake_time_milli": 1403507,
      "total_light_sleep_time_milli": 14905851,
      "total_slow_wave_sleep_time_milli": 6630370,
      "total_rem_sleep_time_milli": 5879573,
      "sleep_cycle_count": 3,
      "disturbance_count": 12
    },
    "sleep_needed": {
      "baseline_milli": 27395716,
      "need_from_sleep_debt_milli": 352230,
      "need_from_recent_strain_milli": 208595,
      "need_from_recent_nap_milli": -12312
    },
    "respiratory_rate": 16.11328125,
    "sleep_performance_percentage": 98,
    "sleep_consistency_percentage": 90,
    "sleep_efficiency_percentage": 91.69533848
  }
}

Changes