---
title: "Sandbox - Single Rest Mode Period Document"
method: GET
path: "/v2/sandbox/usercollection/rest_mode_period/{document_id}"
tags: ["Sandbox Routes"]
---

# Sandbox - Single Rest Mode Period Document

`GET /v2/sandbox/usercollection/rest_mode_period/{document_id}`

## Path parameters

- `document_id` string, required

## Response `200`

Successful Response

- PublicRestModePeriod — Rest mode episode information.
  - `id` string, required — Unique identifier of the object.
  - `end_day` string
  - `end_time` string
  - `episodes` PublicRestModeEpisode[], required — Collection of episodes during rest mode, consisting of tags.
    - `tags` string[], required — Tags selected for the episode.
    - `timestamp` string, required
  - `start_day` string, required
  - `start_time` string

## Other responses

- `400` — Client Exception
- `401` — Unauthorized access exception. Usually means the access token is expired, malformed or revoked.
- `403` — Access forbidden. Usually means the user's subscription to Oura has expired and their data is not available via the API.
- `404` — Not Found
- `422` — Validation Error
- `429` — Request Rate Limit Exceeded.

---

[API](https://skmtc.dev/ouraring/apis/oura-api-documentation.md) · [All operations](https://skmtc.dev/ouraring/apis/oura-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ouraring/oura-api-documentation/revisions/8b8ae3b61eda/schema)