Oura

Oura is a health-technology company that makes the Oura Ring — a titanium smart ring packed with PPG, body-temperature, SpO2, and motion sensors — and the Oura App and Oura Cloud platform that turn raw biometrics into daily Sleep, Activity, Readiness, Stress, and Resilience scores. The Oura Developer Cloud exposes a v2 REST API and webhook subscriptions over OAuth 2.0 and Personal Access Tokens, letting third-party applications read 50+ health metrics, raw heart-rate and interbeat-interval time series, sleep stages, workouts, sessions, user-authored tags, and ring telemetry. A parallel /v2/sandbox/usercollection/* surface provides deterministic sample data for integration testing.

9 APIs 24 Features

ActivityBiometricsCardiovascularFitnessHealthHRVQuantified SelfReadinessResilienceRingSleepSpO2StressWearablesWellnessWomen's Health

APIs

Oura Personal Info API

Retrieve the authenticated user's Oura profile including age, weight, height, biological sex, and email via /v2/usercollection/personal_info. Returned with the personal scope an...

Oura Daily Summaries API

Per-day scored summaries derived from Oura Ring sensor data — daily_activity, daily_sleep, daily_readiness, daily_resilience, daily_stress, daily_spo2, daily_cardiovascular_age,...

Oura Sleep API

Detailed sleep period documents from the ring including HRV, respiratory rate, sleep stages, and movement plus recommended sleep_time windows and user-defined rest_mode_period b...

Oura Activity API

Workout, session (meditation/breathwork/reset), and movement data captured by the Oura Ring. /v2/usercollection/workout returns auto-detected and manually logged workouts; /v2/u...

Oura Heart Rate API

Continuous heart-rate samples and interbeat interval (RR) data captured by the Oura Ring. /v2/usercollection/heartrate returns datetime-bounded BPM samples; /v2/usercollection/i...

Oura Tags API

User-authored annotations attached to specific days or events — legacy /v2/usercollection/tag and structured /v2/usercollection/enhanced_tag. Tags carry custom text, comments, a...

Oura Ring Configuration API

Metadata about the Oura Ring hardware itself — color, design, firmware version, hardware type, set id, and ring battery level samples — via /v2/usercollection/ring_configuration...

Oura Webhooks API

Create, list, renew, update, and delete event subscriptions over /v2/webhook/subscription. Each subscription targets a data_type (sleep, activity, readiness, tag, workout, sessi...

Oura Sandbox API

Mirror of the production usercollection endpoints under /v2/sandbox/usercollection/* that returns deterministic sample data without requiring a connected ring or real user conse...

Collections

Oura API

OPEN

GraphQL

Oura Ring GraphQL Schema

Conceptual GraphQL schema derived from the Oura REST API v2

GRAPHQL

Pricing Plans

Oura Ring Plans Pricing

6 plans

PLANS

Rate Limits

Oura Ring Rate Limits

1 limits

RATE LIMITS

FinOps

Oura Ring Finops

FINOPS

Features

Oura Ring 4 — titanium smart ring with continuous biometric sensing (PPG, body temperature, accelerometer, SpO2)

50+ tracked health metrics across sleep, activity, readiness, stress, resilience, heart, and women's health

Daily Sleep score with sleep stages, latency, efficiency, HRV, respiratory rate, and lowest resting heart rate

Daily Activity score with movement, inactivity, training frequency, and equivalent walking distance

Daily Readiness score combining HRV balance, sleep balance, recovery index, and body temperature deviation

Daily Resilience score capturing long-term stress load and recovery capacity

Daily Stress with high/recovered/relaxed/restored minute-level classification

SpO2 nighttime monitoring with average and breathing-disturbance index

Cardiovascular Age and VO2 Max estimation from continuous heart-rate data

Cycle Insights and Period Prediction (women's health)

Symptom Radar early-illness detection based on temperature and respiratory deviation

Workouts (auto-detected and manual) and Sessions (meditation, breathwork, reset)

Tags and Enhanced Tags (typed user annotations — ailment, lifestyle, nutrition, etc.)

Rest Mode for recovery from illness or injury

Sleep Time recommendation window personalized to the user

REST API v2 with OAuth 2.0 (8 scopes) and Personal Access Tokens

Webhook subscriptions for sleep, activity, readiness, tag, workout, session, daily_*, heartrate (create/update/delete)

Sandbox endpoint family (/v2/sandbox/usercollection/*) returning deterministic sample data for testing

5,000 requests / 5 minutes per access token rate limit

Oura Membership ($5.99/month or $69.99/year) unlocks full insights in the Oura App

Apple Health, Google Health Connect, Strava, Natural Cycles, and other native integrations

FSA/HSA eligibility on ring purchases in the US

Oura for Teams and Oura Health (enterprise wellness)

HIPAA-aligned data handling and SOC 2 controls

Semantic Vocabularies

Oura Ring Context

0 classes · 14 properties

JSON-LD

API Governance Rules

Oura API Rules

7 rules · 1 errors 5 warnings 1 info

SPECTRAL

Example Payloads

Oura Daily Activity Example

2 fields

EXAMPLE

Oura Daily Sleep Example

2 fields

EXAMPLE

Oura Webhook Subscription Create Example

2 fields

EXAMPLE

Resources

Documentation

GettingStarted

Authentication

Authentication

PrivacyPolicy

TermsOfService

Sources

opencollection: 1.0.0
info:
  name: Oura API
  version: '2.0'
items:
- info:
    name: Personal Info Routes
    type: folder
  items:
  - info:
      name: Single Personal Info Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/personal_info'
    docs: Single Personal Info Document
- info:
    name: Tag Routes
    type: folder
  items:
  - info:
      name: Multiple Tag Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/tag'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: N/A. This route does not support field selection yet, all fields will be returned.
    docs: Multiple Tag Documents
  - info:
      name: Single Tag Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/tag/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Tag Document
- info:
    name: Sandbox Routes
    type: folder
  items:
  - info:
      name: Sandbox - Multiple Tag Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/tag'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Tag Documents
  - info:
      name: Sandbox - Multiple Enhanced Tag Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/enhanced_tag'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Enhanced Tag Documents
  - info:
      name: Sandbox - Multiple Workout Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/workout'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Workout Documents
  - info:
      name: Sandbox - Multiple Session Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/session'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Session Documents
  - info:
      name: Sandbox - Multiple Daily Activity Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_activity'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Activity Documents
  - info:
      name: Sandbox - Multiple Daily Sleep Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_sleep'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Sleep Documents
  - info:
      name: Sandbox - Multiple Daily Spo2 Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_spo2'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Spo2 Documents
  - info:
      name: Sandbox - Multiple Daily Readiness Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_readiness'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Readiness Documents
  - info:
      name: Sandbox - Multiple Sleep Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/sleep'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Sleep Documents
  - info:
      name: Sandbox - Multiple Sleep Time Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/sleep_time'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Sleep Time Documents
  - info:
      name: Sandbox - Multiple Rest Mode Period Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/rest_mode_period'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Rest Mode Period Documents
  - info:
      name: Sandbox - Multiple Ring Configuration Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/ring_configuration'
      params:
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Ring Configuration Documents
  - info:
      name: Sandbox - Multiple Daily Stress Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_stress'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Stress Documents
  - info:
      name: Sandbox - Multiple Daily Resilience Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_resilience'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Resilience Documents
  - info:
      name: Sandbox - Multiple Daily Cardiovascular Age Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_cardiovascular_age'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Daily Cardiovascular Age Documents
  - info:
      name: Sandbox - Multiple Vo2 Max Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/vO2_max'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Vo2 Max Documents
  - info:
      name: Sandbox - Single Tag Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/tag/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Tag Document
  - info:
      name: Sandbox - Single Enhanced Tag Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/enhanced_tag/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Enhanced Tag Document
  - info:
      name: Sandbox - Single Workout Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/workout/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Workout Document
  - info:
      name: Sandbox - Single Session Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/session/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Session Document
  - info:
      name: Sandbox - Single Daily Activity Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_activity/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Activity Document
  - info:
      name: Sandbox - Single Daily Sleep Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_sleep/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Sleep Document
  - info:
      name: Sandbox - Single Daily Spo2 Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_spo2/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Spo2 Document
  - info:
      name: Sandbox - Single Daily Readiness Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_readiness/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Readiness Document
  - info:
      name: Sandbox - Single Sleep Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/sleep/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Sleep Document
  - info:
      name: Sandbox - Single Sleep Time Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/sleep_time/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Sleep Time Document
  - info:
      name: Sandbox - Single Rest Mode Period Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/rest_mode_period/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Rest Mode Period Document
  - info:
      name: Sandbox - Single Ring Configuration Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/ring_configuration/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Ring Configuration Document
  - info:
      name: Sandbox - Single Daily Stress Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_stress/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Stress Document
  - info:
      name: Sandbox - Single Daily Resilience Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_resilience/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Resilience Document
  - info:
      name: Sandbox - Single Daily Cardiovascular Age Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/daily_cardiovascular_age/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Daily Cardiovascular Age Document
  - info:
      name: Sandbox - Single Vo2 Max Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/vO2_max/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Sandbox - Single Vo2 Max Document
  - info:
      name: Sandbox - Multiple Heartrate Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/heartrate'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Heartrate Documents
  - info:
      name: Sandbox - Multiple Ring Battery Level Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/ring_battery_level'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Ring Battery Level Documents
  - info:
      name: Sandbox - Multiple Interbeat Interval Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sandbox/usercollection/interbeat_interval'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
    docs: Sandbox - Multiple Interbeat Interval Documents
- info:
    name: Enhanced Tag Routes
    type: folder
  items:
  - info:
      name: Multiple Enhanced Tag Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/enhanced_tag'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: N/A. This route does not support field selection yet, all fields will be returned.
    docs: Multiple Enhanced Tag Documents
  - info:
      name: Single Enhanced Tag Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/enhanced_tag/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Enhanced Tag Document
- info:
    name: Workout Routes
    type: folder
  items:
  - info:
      name: Multiple Workout Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/workout'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Workout Documents
  - info:
      name: Single Workout Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/workout/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Workout Document
- info:
    name: Session Routes
    type: folder
  items:
  - info:
      name: Multiple Session Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/session'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Session Documents
  - info:
      name: Single Session Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/session/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Session Document
- info:
    name: Daily Activity Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Activity Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_activity'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Activity Documents
  - info:
      name: Single Daily Activity Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_activity/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Activity Document
- info:
    name: Daily Sleep Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Sleep Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_sleep'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Sleep Documents
  - info:
      name: Single Daily Sleep Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_sleep/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Sleep Document
- info:
    name: Daily Spo2 Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Spo2 Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_spo2'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Spo2 Documents
  - info:
      name: Single Daily Spo2 Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_spo2/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Spo2 Document
- info:
    name: Daily Readiness Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Readiness Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_readiness'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Readiness Documents
  - info:
      name: Single Daily Readiness Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_readiness/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Readiness Document
- info:
    name: Sleep Routes
    type: folder
  items:
  - info:
      name: Multiple Sleep Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/sleep'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Sleep Documents
  - info:
      name: Single Sleep Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/sleep/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Sleep Document
- info:
    name: Sleep Time Routes
    type: folder
  items:
  - info:
      name: Multiple Sleep Time Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/sleep_time'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Sleep Time Documents
  - info:
      name: Single Sleep Time Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/sleep_time/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Sleep Time Document
- info:
    name: Rest Mode Period Routes
    type: folder
  items:
  - info:
      name: Multiple Rest Mode Period Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/rest_mode_period'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Rest Mode Period Documents
  - info:
      name: Single Rest Mode Period Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/rest_mode_period/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Rest Mode Period Document
- info:
    name: Ring Configuration Routes
    type: folder
  items:
  - info:
      name: Multiple Ring Configuration Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/ring_configuration'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
      - name: next_token
        value: ''
        type: query
    docs: Multiple Ring Configuration Documents
  - info:
      name: Single Ring Configuration Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/ring_configuration/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Ring Configuration Document
- info:
    name: Daily Stress Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Stress Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_stress'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Stress Documents
  - info:
      name: Single Daily Stress Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_stress/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Stress Document
- info:
    name: Daily Resilience Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Resilience Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_resilience'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: N/A. This route does not support field selection yet, all fields will be returned.
    docs: Multiple Daily Resilience Documents
  - info:
      name: Single Daily Resilience Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_resilience/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Resilience Document
- info:
    name: Daily Cardiovascular Age Routes
    type: folder
  items:
  - info:
      name: Multiple Daily Cardiovascular Age Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_cardiovascular_age'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Daily Cardiovascular Age Documents
  - info:
      name: Single Daily Cardiovascular Age Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/daily_cardiovascular_age/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Daily Cardiovascular Age Document
- info:
    name: VO2 Max Routes
    type: folder
  items:
  - info:
      name: Multiple Vo2 Max Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/vO2_max'
      params:
      - name: start_date
        value: ''
        type: query
      - name: end_date
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Vo2 Max Documents
  - info:
      name: Single Vo2 Max Document
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/vO2_max/:document_id'
      params:
      - name: document_id
        value: ''
        type: path
    docs: Single Vo2 Max Document
- info:
    name: Webhook Subscription Routes
    type: folder
  items:
  - info:
      name: List Webhook Subscriptions
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/webhook/subscription'
    docs: List Webhook Subscriptions
  - info:
      name: Create Webhook Subscription
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v2/webhook/subscription'
      body:
        type: json
        data: '{}'
    docs: Create Webhook Subscription
  - info:
      name: Get Webhook Subscription
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/webhook/subscription/:id'
      params:
      - name: id
        value: ''
        type: path
    docs: Get Webhook Subscription
  - info:
      name: Update Webhook Subscription
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v2/webhook/subscription/:id'
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Webhook Subscription
  - info:
      name: Delete Webhook Subscription
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v2/webhook/subscription/:id'
      params:
      - name: id
        value: ''
        type: path
    docs: Delete Webhook Subscription
  - info:
      name: Renew Webhook Subscription
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v2/webhook/subscription/renew/:id'
      params:
      - name: id
        value: ''
        type: path
    docs: Renew Webhook Subscription
- info:
    name: Heart Rate Routes
    type: folder
  items:
  - info:
      name: Multiple Heartrate Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/heartrate'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: latest
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Heartrate Documents
- info:
    name: Ring Battery Level Routes
    type: folder
  items:
  - info:
      name: Multiple Ring Battery Level Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/ring_battery_level'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: latest
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Ring Battery Level Documents
- info:
    name: Interbeat Interval Routes
    type: folder
  items:
  - info:
      name: Multiple Interbeat Interval Documents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/usercollection/interbeat_interval'
      params:
      - name: start_datetime
        value: ''
        type: query
      - name: end_datetime
        value: ''
        type: query
      - name: next_token
        value: ''
        type: query
      - name: latest
        value: ''
        type: query
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response, in addition to the always returned fields.
          Defaults to all fields if not provided.
    docs: Multiple Interbeat Interval Documents
bundled: true