Cycle

GET /v2/cycle/{cycleId}

Changed on

Get the cycle for the specified ID

Request

Path parameters

cycleIdinteger required

ID of the cycle to retrieve

Response

Successful request

idinteger required

Unique identifier for the physiological cycle

user_idinteger required

The WHOOP User for the physiological cycle

created_atstring date-time required

The time the cycle was recorded in WHOOP

updated_atstring date-time required

The time the cycle was last updated in WHOOP

startstring date-time required

Start time bound of the cycle

endstring date-time

End time bound of the cycle. If not present, the user is currently in this cycle

timezone_offsetstring required

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

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

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

step_countinteger nullable

Total number of steps taken during the cycle. Null when no step data exists for the cycle (e.g. the device was not worn for the full cycle).

Example response

{
  "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": {
    "strain": 5.2951527,
    "kilojoule": 8288.297,
    "average_heart_rate": 68,
    "max_heart_rate": 141
  },
  "step_count": 8234
}

Changes