WHwhoop
Recovery

GET /v2/recovery

Changed on

Get all recoveries for a user, paginated. Results are sorted by start time of the related sleep in descending order.

Request

  • Base URL
    https://api.prod.whoop.com/developer
  • Auth
    OAuth 2
    Authorization codehttps://api.prod.whoop.com/oauth/oauth2/auth
    Token URLhttps://api.prod.whoop.com/oauth/oauth2/token
    Scopesread:recovery
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Limit on the number of recoveries returned

startstring date-time

Return recoveries that occurred after or during (inclusive) this time. If not specified, the response will not filter recoveries by a minimum time.

endstring date-time

Return recoveries that intersect this time or ended before (exclusive) this time. If not specified, end will be set to now.

nextTokenstring

Optional next token from the previous response to get the next page. If not provided, the first page in the collection is returned

Response

Successful request

next_tokenstring

A token that can be used on the next request to access the next page of records. If the token is not present, there are no more records in the collection.

Example response

{
  "records": [
    {
      "cycle_id": 93845,
      "sleep_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": 10129,
      "created_at": "2022-04-24T11:25:44.774Z",
      "updated_at": "2022-04-24T14:25:44.774Z",
      "score_state": "SCORED",
      "score": {
        "recovery_score": 44,
        "resting_heart_rate": 64,
        "hrv_rmssd_milli": 31.813562,
        "spo2_percentage": 95.6875,
        "skin_temp_celsius": 33.7
      }
    }
  ],
  "next_token": "MTIzOjEyMzEyMw"
}

Changes