WHOOP · Schema

Sleep

The collection of records in this page.

FitnessWearablesHealthRecoverySleepWorkoutStrainHeart RatePerformance

Properties

Name Type Description
id string Unique identifier for the sleep activity
cycle_id integer Unique identifier for the cycle this sleep belongs to
v1_id integer Previous generation identifier for the activity. Will not exist past 09/01/2025
user_id integer The WHOOP User who performed the sleep activity
created_at string The time the sleep activity was recorded in WHOOP
updated_at string The time the sleep activity was last updated in WHOOP
start string Start time bound of the sleep
end string End time bound of the sleep
timezone_offset string 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'.
nap boolean If true, this sleep activity was a nap for the user
score_state string `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
score object
View JSON Schema on GitHub

JSON Schema

whoop-sleep-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whoop/main/json-schema/whoop-sleep-schema.json",
  "title": "Sleep",
  "description": "The collection of records in this page.",
  "required": [
    "created_at",
    "cycle_id",
    "end",
    "id",
    "nap",
    "score_state",
    "start",
    "timezone_offset",
    "updated_at",
    "user_id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the sleep activity",
      "format": "uuid",
      "example": "ecfc6a15-4661-442f-a9a4-f160dd7afae8"
    },
    "cycle_id": {
      "type": "integer",
      "description": "Unique identifier for the cycle this sleep belongs to",
      "format": "int64",
      "example": 93845
    },
    "v1_id": {
      "type": "integer",
      "description": "Previous generation identifier for the activity. Will not exist past 09/01/2025",
      "format": "int64",
      "example": 93845
    },
    "user_id": {
      "type": "integer",
      "description": "The WHOOP User who performed the sleep activity",
      "format": "int64",
      "example": 10129
    },
    "created_at": {
      "type": "string",
      "description": "The time the sleep activity was recorded in WHOOP",
      "format": "date-time",
      "example": "2022-04-24T11:25:44.774Z"
    },
    "updated_at": {
      "type": "string",
      "description": "The time the sleep activity was last updated in WHOOP",
      "format": "date-time",
      "example": "2022-04-24T14:25:44.774Z"
    },
    "start": {
      "type": "string",
      "description": "Start time bound of the sleep",
      "format": "date-time",
      "example": "2022-04-24T02:25:44.774Z"
    },
    "end": {
      "type": "string",
      "description": "End time bound of the sleep",
      "format": "date-time",
      "example": "2022-04-24T10:25:44.774Z"
    },
    "timezone_offset": {
      "type": "string",
      "description": "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'.",
      "example": "-05:00",
      "externalDocs": {
        "description": "Learn more about the Time Zone Designator from the W3C Standard",
        "url": "https://www.w3.org/TR/NOTE-datetime"
      }
    },
    "nap": {
      "type": "boolean",
      "description": "If true, this sleep activity was a nap for the user",
      "example": false
    },
    "score_state": {
      "type": "string",
      "description": "`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": "SCORED",
      "enum": [
        "SCORED",
        "PENDING_SCORE",
        "UNSCORABLE"
      ]
    },
    "score": {
      "$ref": "#/components/schemas/SleepScore"
    }
  }
}