List sleep periods
list_sleep_periodsRetrieve individual sleep periods with bedtime, sleep stages, duration, heart rate, HRV, and readiness scores across a date range. Exclude naps or rejected periods and paginate results.
Instructions
List individual sleep periods (nights and, by default, naps) with bedtime, hours in bed and asleep, deep/REM/light/awake hours, latency, efficiency, average and lowest heart rate, average HRV, breathing rate and the readiness score each produced. Use it for sleep duration, stages and overnight HRV or heart rate across days; use list_daily_sleep for scores only, and pass a sleep_id to get_sleep_period for the full hypnogram. Periods the user rejected or deleted are left out, and each period belongs to the day the user woke up. Range: the last 7 days by default; set start and end (inclusive, YYYY-MM-DD) or days (up to 400, ignored when start is set). Returns { records, next_token }, oldest first. Days without data are absent, and today's data appears only after the ring syncs. If next_token is not null, call again with it for the rest. raw: true returns Oura's original objects.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Last day to include (YYYY-MM-DD). Defaults to today. | |
| raw | No | Return Oura's raw API objects instead of compact summaries with friendly units. | |
| days | No | Shortcut for start: the last N days up to end. Ignored when start is set. | |
| start | No | First day to include (YYYY-MM-DD). | |
| next_token | No | Pass the next_token from a previous call to get the following records. | |
| include_naps | No | Set false to return only long (main) sleeps. |