openapi: 3.0.3
info:
  title: Oura API Documentation Daily Activity Routes Sleep Routes API
  description: "# Overview \nThe Oura API allows Oura users and partner applications to improve their user experience with Oura data.\nThis document describes the Oura API Version 2 (V2), which is the only available integration point for Oura data. The previous V1 API has been sunset.\n# Getting Started \n## What is an API?\nAn API (Application Programming Interface) allows different software applications to communicate with each other. The Oura API enables you to access your Oura Ring data programmatically.\n## Quick Start Guide\n1. Register an [API Application](https://cloud.ouraring.com/oauth/applications) and implement OAuth2\n2. **Make Your First API Call**:\n   ```\n   curl -X GET https://api.ouraring.com/v2/usercollection/personal_info \\\n   -H \"Authorization: Bearer YOUR_TOKEN_HERE\"\n   ```\n3. **Explore Data Types**:\n   - Browse the available endpoints in this documentation to discover what data you can access\n   - Each endpoint includes example requests and responses\n4. **Set Up Webhooks (Strongly Recommended)**:\n   - Webhooks are the preferred way to consume Oura data\n   - We have not had customers hit rate limits with webhooks properly implemented\n   - Make a single request for historical data when a user first connects, then use webhooks for ongoing updates\n   - Webhook notifications come approximately 30 seconds after data syncs from the mobile app\n   - [Set up webhooks](#tag/Webhook-Subscription-Routes) to receive notifications when data changes\n## Common Questions\n- **Data Delay**: Different data types sync at different times - sleep data requires users to open the Oura app, while daily activity and stress may sync in the background\n# Data Access\nIn order to access data, a registered [API Application](https://cloud.ouraring.com/oauth/applications) is required.\n API Applications are limited to **10** users before requiring approval from Oura. There is no limit once an application is approved.\n Additionally, Oura users **must provide consent** to share each data type an API Application has access to.\nAll data access requests through the Oura API require [Authentication](https://cloud.ouraring.com/docs/authentication).\nAdditionally, we recommend that Oura users keep their mobile app updated to support API access for the latest data types.\n# Authentication\nThe Oura Cloud API supports authentication through the industry-standard OAuth2 protocol. For more information, see our [Authentication instructions](https://cloud.ouraring.com/docs/authentication).\nAccess tokens must be included in the request header as follows:\n```http\nGET /v2/usercollection/personal_info HTTP/1.1\nHost: api.ouraring.com\nAuthorization: Bearer <token>\n```\nPlease note that personal access tokens were deprecated in December 2025 and are no longer available for use.\n# Oura HTTP Response Codes\n| Response Code                        | Description |\n| ------------------------------------ | - |\n| 200 OK                               | Successful Response         |\n| 400 Query Parameter Validation Error | The request contains query parameters that are invalid or incorrectly formatted. |\n| 401 Unauthorized                     | Invalid or expired authentication token. |\n| 403 Forbidden                        | The requested resource requires additional permissions or the user's Oura subscription has expired. |\n| 429 Too Many Requests                | Rate limit exceeded. See response headers for retry guidance. |\n\n## Rate Limits\nThe API enforces rate limits at two layers to ensure fair access across all applications:\n- a per-access-token limit, which throttles single-token floods, and\n- a per-application limit, which caps the aggregate traffic across all of an application's end-user tokens so one fan-out app can't dominate shared capacity.\n\nA request that trips either layer receives a `429 Too Many Requests`. The `X-RateLimit-Tier` response header identifies which layer fired.\n\nIf your application regularly approaches rate limits, [webhooks](#tag/Webhook-Subscription-Routes) are strongly recommended — most applications that implement webhooks correctly do not encounter rate limit issues.\n\n[Contact us](mailto:api-support@ouraring.com) if you expect your usage to require higher limits.\n\n## Rate Limit Response Headers\nWhen a `429 Too Many Requests` response is returned, five headers are included to guide retries. Prefer these over fixed-interval backoff:\n- **`Retry-After`** — integer seconds to wait before retrying. RFC 7231-compliant; safe to feed directly into your client's backoff logic.\n- **`X-RateLimit-Limit`** — the request ceiling for the current window.\n- **`X-RateLimit-Window`** — the rolling window length in seconds that the ceiling applies to.\n- **`X-RateLimit-Reset`** — Unix epoch (seconds) at which the window resets and quota is fully restored.\n- **`X-RateLimit-Tier`** — identifies which limit was exceeded, useful when contacting support.\n"
  termsOfService: https://cloud.ouraring.com/legal/api-agreement
  version: '2.0'
  x-logo:
    url: /v2/static/img/Oura_Logo-Developer_RBG_Black.svg
servers:
- url: https://api.ouraring.com
  description: Oura API
tags:
- name: Sleep Routes
  description: Returns Oura Sleep data for the specified Oura user within a given timeframe. A user can have multiple sleep periods per day.
paths:
  /v2/usercollection/sleep:
    get:
      tags:
      - Sleep Routes
      summary: Multiple Sleep Documents
      operationId: Multiple_sleep_Documents_v2_usercollection_sleep_get
      parameters:
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
          - type: 'null'
          title: End Date
      - name: next_token
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Next Token
      - name: fields
        in: query
        required: false
        schema:
          type: string
          nullable: true
          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.
          title: Fields
        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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/MultiDocumentResponse_PublicModifiedSleepModel_'
                - $ref: '#/components/schemas/MultiDocumentResponseDict'
                title: Response Multiple Sleep Documents V2 Usercollection Sleep Get
        '400':
          description: Client Exception
        '401':
          description: Unauthorized access exception. Usually means the access token is expired, malformed or revoked.
        '403':
          description: Access forbidden. Usually means the user's subscription to Oura has expired and their data is not available via the API.
        '429':
          description: Request Rate Limit Exceeded.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
      - OAuth2: []
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: 'curl --location --request GET ''https://api.ouraring.com/v2/usercollection/sleep?start_date=2021-11-01&end_date=2021-12-01&fields=day,score'' \

          --header ''Authorization: Bearer <token>'''
      - lang: Python
        source: "import requests \nurl = 'https://api.ouraring.com/v2/usercollection/sleep' \nparams={ \n    'start_date': '2021-11-01', \n    'end_date': '2021-12-01',\n    'fields': 'day,score' \n}\nheaders = { \n  'Authorization': 'Bearer <token>' \n}\nresponse = requests.request('GET', url, headers=headers, params=params) \nprint(response.text)"
        label: Python
      - lang: JavaScript
        source: "var myHeaders = new Headers(); \nmyHeaders.append('Authorization', 'Bearer <token>'); \nvar requestOptions = { \n  method: 'GET', \n  headers: myHeaders, \n}; \nfetch('https://api.ouraring.com/v2/usercollection/sleep?start_date=2021-11-01&end_date=2021-12-01&fields=day,score', requestOptions) \n  .then(response => response.text()) \n  .then(result => console.log(result)) \n  .catch(error => console.log('error', error));"
        label: JavaScript
      - lang: Java
        source: "OkHttpClient client = new OkHttpClient().newBuilder() \n  .build(); \nRequest request = new Request.Builder() \n  .url(\"https://api.ouraring.com/v2/usercollection/sleep?start_date=2021-11-01&end_date=2021-12-01&fields=day,score\") \n  .method(\"GET\", null) \n  .addHeader(\"Authorization\", \"Bearer <token>\") \n  .build(); \nResponse response = client.newCall(request).execute();"
        label: Java
  /v2/usercollection/sleep/{document_id}:
    get:
      tags:
      - Sleep Routes
      summary: Single Sleep Document
      operationId: Single_sleep_Document_v2_usercollection_sleep__document_id__get
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicModifiedSleepModel'
        '404':
          description: Not Found
        '400':
          description: Client Exception
        '401':
          description: Unauthorized access exception. Usually means the access token is expired, malformed or revoked.
        '403':
          description: Access forbidden. Usually means the user's subscription to Oura has expired and their data is not available via the API.
        '429':
          description: Request Rate Limit Exceeded.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
      - OAuth2: []
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: 'curl --location --request GET ''https://api.ouraring.com/v2/usercollection/sleep/2-5daccc095220cc5493a4e9c2b681ca941e'' \

          --header ''Authorization: Bearer <token>'''
      - lang: Python
        source: "import requests \nurl = 'https://api.ouraring.com/v2/usercollection/sleep/2-5daccc095220cc5493a4e9c2b681ca941e' \nheaders = { \n  'Authorization': 'Bearer <token>' \n}\nresponse = requests.request('GET', url, headers=headers, params=params) \nprint(response.text)"
        label: Python
      - lang: JavaScript
        source: "var myHeaders = new Headers(); \nmyHeaders.append('Authorization', 'Bearer <token>'); \nvar requestOptions = { \n  method: 'GET', \n  headers: myHeaders, \n}; \nfetch('https://api.ouraring.com/v2/usercollection/sleep/2-5daccc095220cc5493a4e9c2b681ca941e', requestOptions) \n  .then(response => response.text()) \n  .then(result => console.log(result)) \n  .catch(error => console.log('error', error));"
        label: JavaScript
      - lang: Java
        source: "OkHttpClient client = new OkHttpClient().newBuilder() \n  .build(); \nRequest request = new Request.Builder() \n  .url(\"https://api.ouraring.com/v2/usercollection/sleep/2-5daccc095220cc5493a4e9c2b681ca941e\") \n  .method(\"GET\", null) \n  .addHeader(\"Authorization\", \"Bearer <token>\") \n  .build(); \nResponse response = client.newCall(request).execute();"
        label: Java
components:
  schemas:
    PublicReadiness:
      properties:
        contributors:
          $ref: '#/components/schemas/PublicReadinessContributors'
          title: ''
          description: Contributors of the readiness score.
        score:
          type: integer
          nullable: true
          title: ''
          description: Readiness score in range [1, 100].
        temperature_deviation:
          type: number
          nullable: true
          title: ''
          description: Temperature deviation in degrees Celsius.
        temperature_trend_deviation:
          type: number
          nullable: true
          title: ''
          description: Temperature trend deviation in degrees Celsius.
      type: object
      required:
      - contributors
      title: PublicReadiness
      description: Object defining readiness.
    PublicSample:
      properties:
        interval:
          type: number
          title: ''
          description: Interval in seconds between the sampled items.
        items:
          $ref: '#/components/schemas/Array_Union_float__NoneType__Bits64_'
          title: ''
          description: Recorded sample items.
        timestamp:
          $ref: '#/components/schemas/LocalizedDateTime'
          title: ''
          description: Timestamp when the sample recording started.
      type: object
      required:
      - interval
      - items
      - timestamp
      title: PublicSample
      description: Object defining a recorded sample.
    MultiDocumentResponse_PublicModifiedSleepModel_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PublicModifiedSleepModel'
          type: array
          title: Data
        next_token:
          type: string
          nullable: true
          title: Next Token
      type: object
      required:
      - data
      - next_token
      title: MultiDocumentResponse[PublicModifiedSleepModel]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Array_Union_float__NoneType__Bits64_:
      items:
        type: number
        nullable: true
      type: array
      title: ArrayNullableFloatBits64
    PublicSleepAnalysisReason:
      type: string
      enum:
      - foreground_sleep_analysis
      - bedtime_edit
      title: PublicSleepAnalysisReason
      description: Possible sleep analysis reasons.
    LocalizedDateTime:
      type: string
    PublicSleepType:
      type: string
      enum:
      - deleted
      - sleep
      - long_sleep
      - late_nap
      - rest
      title: PublicSleepType
      description: 'Possible sleep period types.

        ''deleted'' = deleted sleep by user.

        ''sleep'' = user confirmed sleep / nap, min 15 minutes, max 3 hours, contributes to daily scores

        ''late_nap'' = user confirmed sleep / nap, min 15 minutes, ended after sleep day change (6 pm), contributes to next days daily scores

        ''long_sleep'' = sleep that is long enough (>3h) to automatically contribute to daily scores

        ''rest'' = Falsely detected sleep / nap, rejected in confirm prompt by user'
    PublicSleepAlgorithmVersion:
      type: string
      enum:
      - v1
      - v2
      title: PublicSleepAlgorithmVersion
      description: 'Oura Sleep Staging Algorithms.

        v1 = original aka legacy aka OSSA 1.0,

        v2 = latest sleep algorithm'
    PublicReadinessContributors:
      properties:
        activity_balance:
          type: integer
          nullable: true
          title: ''
          description: Contribution of cumulative activity balance in range [1, 100].
        body_temperature:
          type: integer
          nullable: true
          title: ''
          description: Contribution of body temperature in range [1, 100].
        hrv_balance:
          type: integer
          nullable: true
          title: ''
          description: Contribution of heart rate variability balance in range [1, 100].
        previous_day_activity:
          type: integer
          nullable: true
          title: ''
          description: Contribution of previous day's activity in range [1, 100].
        previous_night:
          type: integer
          nullable: true
          title: ''
          description: Contribution of previous night's sleep in range [1, 100].
        recovery_index:
          type: integer
          nullable: true
          title: ''
          description: Contribution of recovery index in range [1, 100].
        resting_heart_rate:
          type: integer
          nullable: true
          title: ''
          description: Contribution of resting heart rate in range [1, 100].
        sleep_balance:
          type: integer
          nullable: true
          title: ''
          description: Contribution of sleep balance in range [1, 100].
        sleep_regularity:
          type: integer
          nullable: true
          title: ''
          description: Contribution of sleep regularity in range [1, 100].
      type: object
      title: PublicReadinessContributors
      description: Object defining readiness score contributors.
    PublicModifiedSleepModel:
      properties:
        id:
          type: string
          minLength: 1
          title: ''
          description: Unique identifier of the object.
        average_breath:
          type: number
          nullable: true
          title: ''
          description: Average breathing rate during sleep as breaths/minute.
        average_heart_rate:
          type: number
          nullable: true
          title: ''
          description: 'Average heart rate during sleep as beats/minute. NOTE: this is the average calculated by ecore (based on 30-second samples) which is different from what is shown in the app. The app shows the average of aggregated 5-minute heart rate samples.'
        average_hrv:
          type: integer
          nullable: true
          title: ''
          description: Average heart rate variability during sleep.
        awake_time:
          type: integer
          nullable: true
          title: ''
          description: Duration spent awake in seconds.
        bedtime_end:
          $ref: '#/components/schemas/LocalizedDateTime'
          title: ''
          description: Bedtime end of the sleep.
        bedtime_start:
          $ref: '#/components/schemas/LocalizedDateTime'
          title: ''
          description: Bedtime start of the sleep.
        day:
          $ref: '#/components/schemas/ISODate'
          title: ''
          description: Day that the sleep belongs to.
        deep_sleep_duration:
          type: integer
          nullable: true
          title: ''
          description: Duration spent in deep sleep in seconds.
        efficiency:
          type: integer
          nullable: true
          title: ''
          description: Sleep efficiency rating in range [1, 100].
        heart_rate:
          $ref: '#/components/schemas/PublicSample'
          nullable: true
          title: ''
          description: Object containing heart rate samples.
        hrv:
          $ref: '#/components/schemas/PublicSample'
          nullable: true
          title: ''
          description: Object containing heart rate variability samples.
        latency:
          type: integer
          nullable: true
          title: ''
          description: Sleep latency in seconds. This is the time it took for the user to fall asleep after going to bed.
        light_sleep_duration:
          type: integer
          nullable: true
          title: ''
          description: Duration spent in light sleep in seconds.
        low_battery_alert:
          type: boolean
          title: ''
          description: Flag indicating if a low battery alert occurred.
        lowest_heart_rate:
          type: integer
          nullable: true
          title: ''
          description: 'Lowest heart rate during sleep. NOTE: this is the value calculated by ecore (based on 30-second samples) which is different from what is shown in the app. The app shows the minimum of aggregated 5-minute heart rate samples.'
        movement_30_sec:
          type: string
          nullable: true
          title: ''
          description: '30-second movement classification for the period where every character corresponds to:

            ''1'' = no motion,

            ''2'' = restless,

            ''3'' = tossing and turning

            ''4'' = active

            Example: "1143222134".'
        period:
          type: integer
          title: ''
          description: ECore sleep period identifier.
        readiness:
          $ref: '#/components/schemas/PublicReadiness'
          nullable: true
          title: ''
          description: Object containing the readiness details.
        readiness_score_delta:
          type: integer
          nullable: true
          title: ''
          description: Effect on readiness score caused by this sleep period.
        rem_sleep_duration:
          type: integer
          nullable: true
          title: ''
          description: Duration spent in REM sleep in seconds.
        restless_periods:
          type: integer
          nullable: true
          title: ''
          description: Number of restless periods during sleep.
        sleep_algorithm_version:
          $ref: '#/components/schemas/PublicSleepAlgorithmVersion'
          nullable: true
          title: ''
          description: Version of the sleep algorithm used to calculate the sleep data.
        sleep_analysis_reason:
          $ref: '#/components/schemas/PublicSleepAnalysisReason'
          nullable: true
          title: ''
          description: The reason for the creation or update of the latest version of this sleep.
        sleep_phase_30_sec:
          type: string
          nullable: true
          title: ''
          description: '30-second sleep phase classification for the period where every character corresponds to:

            ''1'' = deep sleep,

            ''2'' = light sleep,

            ''3'' = REM sleep

            ''4'' = awake.

            Example: "444423323441114".'
        sleep_phase_5_min:
          type: string
          nullable: true
          title: ''
          description: '5-minute sleep phase classification for the period where every character corresponds to:

            ''1'' = deep sleep,

            ''2'' = light sleep,

            ''3'' = REM sleep

            ''4'' = awake.

            Example: "444423323441114".'
        sleep_score_delta:
          type: integer
          nullable: true
          title: ''
          description: Effect on sleep score caused by this sleep period.
        time_in_bed:
          type: integer
          title: ''
          description: Duration spent in bed in seconds.
        total_sleep_duration:
          type: integer
          nullable: true
          title: ''
          description: Total sleep duration in seconds.
        type:
          $ref: '#/components/schemas/PublicSleepType'
          nullable: true
          title: ''
          description: Type of the sleep period.
        ring_id:
          type: string
          nullable: true
          title: Ring Id
          description: Encrypted identifier of the ring that produced this sleep data.
        app_sleep_phase_5_min:
          type: string
          nullable: true
          title: App Sleep Phase 5 Min
          description: "\n        5-minute sleep phase classification for the period aligned with what is shown in the app\n        where every character corresponds to:\n        '1' = deep sleep,\n        '2' = light sleep,\n        '3' = REM sleep\n        '4' = awake.\n        Example: \"444423323441114\".\n        NOTE: This field will be removed in the future after a transition period.\n        "
      type: object
      required:
      - id
      - bedtime_end
      - bedtime_start
      - day
      - low_battery_alert
      - period
      - time_in_bed
      title: PublicModifiedSleepModel
      x-cloud-only: true
      x-collection: publicsleepmodel
      x-owner: sleep-squad
    ISODate:
      type: string
    MultiDocumentResponseDict:
      properties:
        data:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Data
        next_token:
          type: string
          nullable: true
          title: Next Token
      type: object
      required:
      - data
      - next_token
      title: MultiDocumentResponseDict
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://cloud.ouraring.com/oauth/authorize
          tokenUrl: https://api.ouraring.com/oauth/token
          scopes:
            email: Email address of the user
            personal: Personal information (gender, age, height, weight)
            daily: Daily summaries of sleep, activity and readiness
            heartrate: Time series heart rate for Gen 3 users
            workout: Summaries for auto-detected and user entered workouts
            tag: User entered tags
            session: Guided and unguided sessions in the Oura app
            spo2Daily: SpO2 Average recorded during sleep
    ClientIdAuth:
      type: apiKey
      in: header
      name: x-client-id
      description: Client ID for webhook subscription endpoints. Must be used together with x-client-secret header.
    ClientSecretAuth:
      type: apiKey
      in: header
      name: x-client-secret
      description: Client Secret for webhook subscription endpoints. Must be used together with x-client-id header.