---
title: "Circadian bedtime period data (date range)"
method: GET
path: "/v3/users/sleepwise/circadian-bedtime/date"
tags: ["SleepWise™"]
---

# Circadian bedtime period data (date range)

`GET /v3/users/sleepwise/circadian-bedtime/date`

## Request

- Base URL: `https://www.polaraccesslink.com`
- URL: `https://www.polaraccesslink.com/v3/users/sleepwise/circadian-bedtime/date`
- Auth: OAuth 2
  - Authorization code: `https://flow.polar.com/oauth2/authorization`
  - Token URL: `https://polarremote.com/v2/oauth2/token` scopes: `accesslink.read_all`
- TypeScript: <https://skmtc.dev/polar-com/apis/polar-accesslink-api/docs/v3/users/sleepwise/circadian-bedtime/date/get.ts> (a function with typed inputs; its response is checked against the schema)

Get user's circadian bedtime period data for given date range. Maximum date range between from and to cannot be more than 28 days. <a href="https://support.polar.com/en/polar-sleepwise"> Supported devices </a>

## Query parameters

- `from` string, date, required
- `to` string, date, required

## Response `200`

Request was successful.

- CircadianBedtime[]
  - `validity` 'VALIDITY_UNKNOWN' | 'VALIDITY_RESET' | 'VALIDITY_NOT_VALID' | 'VALIDITY_ESTIMATE' | 'VALIDITY_VALID': Validity
  - `quality` 'CIRCADIAN_BEDTIME_QUALITY_UNKNOWN' | 'CIRCADIAN_BEDTIME_QUALITY_WEAK' | 'CIRCADIAN_BEDTIME_QUALITY_COMPROMISED' | 'CIRCADIAN_BEDTIME_QUALITY_CLEARLY_RECOGNIZABLE': Quality
  - `result_type` 'CIRCADIAN_BEDTIME_TYPE_UNKNOWN' | 'CIRCADIAN_BEDTIME_TYPE_PREDICTION' | 'CIRCADIAN_BEDTIME_TYPE_HISTORY': Result type
  - `period_start_time` string, date-time: Circadian bedtime period start time (UTC)
  - `period_end_time` string, date-time: Circadian bedtime period end time (UTC)
  - `preferred_sleep_period_start_time` string, date-time: Circadian bedtime preferred sleep period start time (UTC)
  - `preferred_sleep_period_end_time` string, date-time: Circadian bedtime preferred sleep period end time (UTC)
  - `sleep_gate_start_time` string, date-time: Circadian bedtime sleep gate (suggested fall a sleep window) start time (UTC)
  - `sleep_gate_end_time` string, date-time: Circadian bedtime sleep gate (suggested fall a sleep window) end time (UTC)
  - `sleep_timezone_offset_minutes` integer: Sleep timezone offset minutes

## Other responses

- `204`: No data found for date range.
- `400`: Invalid request.
- `401`: Unauthorized.
- `403`: User has not accepted all mandatory consents.

## Changes

- **2026-11-06** `18ce96365320`: 6 breaking
  - the `items/period_end_time` response's property format changed from `date` to `date-time` for status `200`
  - the `items/period_start_time` response's property format changed from `date` to `date-time` for status `200`
  - the `items/preferred_sleep_period_end_time` response's property format changed from `date` to `date-time` for status `200`
  - the `items/preferred_sleep_period_start_time` response's property format changed from `date` to `date-time` for status `200`
  - …2 more
- **2026-02-07** `f197848bba31`: 2 info
  - api tag `SleepWise&trade;` added
  - api tag `SleepWise&trade; (Beta)` removed
- **2025-06-04** `5ef2cea678a2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/polar-com/apis/polar-accesslink-api/changes/v3/users/sleepwise/circadian-bedtime/date/get.md)

---

[API](https://skmtc.dev/polar-com/apis/polar-accesslink-api.md) - [All operations](https://skmtc.dev/polar-com/apis/polar-accesslink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polar-com/apis/polar-accesslink-api/revisions/18ce96365320?raw)