List rest mode periods
list_rest_mode_periodsList Rest Mode periods with start/end dates and symptom tags to explain dips in readiness or activity or check if the user was unwell on specific days.
Instructions
List Rest Mode periods, which the user turns on when sick, injured or recovering, with start and end day (an ongoing period has no end) and the symptom tags logged during each. Use it to explain dips in readiness or activity, or to check whether the user was unwell on given days. Covers the last 90 days by default; set start and end (inclusive, YYYY-MM-DD) or days. A period that overlaps the range is included. Returns { records, next_token }; 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 | The last N days up to end. Ignored when start is set. | |
| start | No | First day to include (YYYY-MM-DD). |