---
title: "Sleep v2 - Get"
method: POST
path: "https://wbsapi.withings.net/v2/sleep"
tags: ["sleep"]
---

# Sleep v2 - Get

`POST https://wbsapi.withings.net/v2/sleep`

## Request

- Base URL: `https://wbsapi.withings.net`
- URL: `https://wbsapi.withings.net/https://wbsapi.withings.net/v2/sleep`
- Auth: none declared. Required headers: `Authorization`

Returns sleep data captured at high frequency, including sleep stages.<br/><br/>
**Notes**
If your input ```startdate``` and ```enddate``` are separated by more than 24h, only the first 24h after ```startdate``` will be returned.<br/><br/>
**IMPORTANT**: Please refer to this [page](https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/#sleep) to check the availability of metrics based on the sleep tracking device used. Some data types are regulated in the EU and US and may not be available in your region.

## Query parameters

- `action` string, required
- `startdate` integer, required
- `enddate` integer, required
- `data_fields` string
- `meastypes` unknown

## Headers

- `Authorization` string, required

## Response `200`

(Click to unfold)

- object
  - `status` integer: Response status. See <a href='#tag/response_status'>Status</a> section for details.
  - `body` object: Response data.
    - `model` integer: The source for sleep data. Value can be 16 for a tracker or 32 for a Sleep Monitor.
    - `series` object
      - `startdate` integer: The starting datetime for the sleep state data.
      - `enddate` integer: The end datetime for the sleep data. A single call can span up to 7 days maximum. To cover a wider time range, you will need to perform multiple calls.
      - `state` integer: The state of sleeping. Values can be: | Value | Description| |---|---| |0 | Sleep state awake| |1 | Sleep state light| |2 | Sleep state deep| |3 | Sleep state rem| |4 | Sleep manual| |5 | Sleep unspecified| |15 | Sleep out of bed (require a specific plan, <a href='https://developer.withings.com/developer-guide/v3/withings-solutions/withings-api-plans/'>contact-us</a>)|
      - `model` string: Device model. Value can be: | Value | Description| |---|---| |Aura Dock | Sleep Monitor| |Aura Sensor | Sleep Monitor| |Aura Sensor V2 | Sleep Monitor| |Pulse | Activity Tracker| |Activite | Activity Tracker| |Activite (Pop, Steel) | Activity Tracker| |Withings Go | Activity Tracker| |Activite Steel HR | Activity Tracker| |Activite Steel HR Sport Edition | Activity Tracker| |Pulse HR | Activity Tracker| |Move | Activity Tracker| |Move ECG | Activity Tracker| |ScanWatch | Activity Tracker| |ScanWatch 2 | Activity Tracker| |ScanWatch Light | Activity Tracker|
      - `model_id` integer: | Value | Description| |---|---| |60 | Aura Dock| |61 | Aura Sensor| |63 | Aura Sensor V2| |51 | Pulse| |52 | Activite| |53 | Activite (Pop, Steel)| |54 | Withings Go| |55 | Activite Steel HR| |59 | Activite Steel HR Sport Edition| |58 | Pulse HR| |90 | Move| |91 | Move ECG| |92 | Move ECG| |93 | ScanWatch| |94 | ScanWatch 2| |95 | ScanWatch Light|
      - `hr` object: Heart Rate (beats per minute). *(Use 'data_fields' to request this data.)*
        - `$timestamp` integer: $timestamp represents the epoch value of the heart rate data, value of this key will be the heart rate data
      - `rr` object: Respiration Rate (breaths per minute). *(Use 'data_fields' to request this data.)*
        - `$timestamp` integer: $timestamp represents the epoch value of the respiration rate data, value of this key will be the respiration rate data
      - `snoring` object: Total snoring time (seconds).
        - `$timestamp` integer
      - `sdnn_1` object: Heart rate variability - Standard deviation of the NN over 1 minute (in miliseconds).
        - `$timestamp` integer
      - `rmssd` object: Heart rate variability - Root mean square of the successive differences over "a few seconds" (in miliseconds).
        - `$timestamp` integer
      - `hrv_quality` object: Heart rate variability - quality score.
        - `$timestamp` integer
      - `mvt_score` object: Track the intensity of movement in bed on a minute-by-minute basis. The score ranges from 0 to 255, representing the intensity of movement. This metric is only available for Sleep Analyzer devices in the EU and prescription-based devices in the US (Sleep Rx).
        - `$timestamp` integer
      - `chest_movement_rate` object: Chest movement rate (events per minute). *(Use 'data_fields' to request this data.)*
        - `$timestamp` integer
      - `withings_index` object: Withings Sleep Rx (FDA Cleared) allows to estimate gaps in breathing sounds and to generate an index. This index corresponds to the number of breathing events per hour. <table><thead><tr><td>Value</td><td>Description</td></tr></thead><tbody><tr><td>0-15 (events per hour on average)</td><td>No/Mild</td></tr><tr><td>15-30 (events per hour on average)</td><td>Moderate</td></tr><tr><td>> 30 (events per hour on average)</td><td>Severe</td></tr></tbody></table> Note: 5 hours of sleep are required in order to calculate the Withings Index.
        - `$timestamp` integer
      - `breathing_sounds` object: Total time when breathing sounds were tracked. (seconds) *(Use 'data_fields' to request this data.)*
        - `$timestamp` integer

---

[API](https://skmtc.dev/withings/apis/withings-developer-documentation.md) - [All operations](https://skmtc.dev/withings/apis/withings-developer-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/withings/apis/withings-developer-documentation/revisions/9e9accd01d4b?raw)