How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oura Ring Sandbox Routes API

Fake user data that you can access without an Oura account. There is a corresponding sandbox endpoint to each available data type. This is useful for testing and development purposes. The data is not real and should not be used for any production purposes. The data is generated by Oura and is not based on any real user data. The data is not updated in real-time and is not guaranteed to be accurate. The rate limit for the sandbox endpoints is shared with your rate limit on other data endpoints.

Oura Ring Sandbox Routes API is one of 21 APIs that Oura Ring publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Sandbox Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 1 JSON Schema.

This API exposes 34 operations across 34 paths, and defines 69 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.ouraring.com.

34 operations 34 paths 69 schemas 34 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.ouraring.com/v2
Authentication
HTTP Bearer, OAuth 2.0, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 4

Oura Ring Sandbox Routes API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 8 scopes. An API key is passed in the header as x-client-id (ClientIdAuth). An API key is passed in the header as x-client-secret (ClientSecretAuth).

  • ClientIdAuth — Client ID for webhook subscription endpoints. Must be used together with x-client-secret header.
  • ClientSecretAuth — Client Secret for webhook subscription endpoints. Must be used together with x-client-id header.

Paths & Operations 34

Across 34 paths, the API surfaces 34 operations — 34 GET. Each is listed below with its method, path, parameters, and response codes.

Sandbox Routes 34

Fake user data that you can access without an Oura account. There is a corresponding sandbox endpoint to each available data type. This is useful for testing and development purpo…

GET
/v2/sandbox/usercollection/tag
Sandbox - Multiple Tag Documents
Sandbox___Multiple_tag_Documents_v2_sandbox_usercollection_tag_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/enhanced_tag
Sandbox - Multiple Enhanced Tag Documents
Sandbox___Multiple_enhanced_tag_Documents_v2_sandbox_usercollection_enhanced_tag_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/workout
Sandbox - Multiple Workout Documents
Sandbox___Multiple_workout_Documents_v2_sandbox_usercollection_workout_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/session
Sandbox - Multiple Session Documents
Sandbox___Multiple_session_Documents_v2_sandbox_usercollection_session_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_activity
Sandbox - Multiple Daily Activity Documents
Sandbox___Multiple_daily_activity_Documents_v2_sandbox_usercollection_daily_activity_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_sleep
Sandbox - Multiple Daily Sleep Documents
Sandbox___Multiple_daily_sleep_Documents_v2_sandbox_usercollection_daily_sleep_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_spo2
Sandbox - Multiple Daily Spo2 Documents
Sandbox___Multiple_daily_spo2_Documents_v2_sandbox_usercollection_daily_spo2_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_readiness
Sandbox - Multiple Daily Readiness Documents
Sandbox___Multiple_daily_readiness_Documents_v2_sandbox_usercollection_daily_readiness_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/sleep
Sandbox - Multiple Sleep Documents
Sandbox___Multiple_sleep_Documents_v2_sandbox_usercollection_sleep_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/sleep_time
Sandbox - Multiple Sleep Time Documents
Sandbox___Multiple_sleep_time_Documents_v2_sandbox_usercollection_sleep_time_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/rest_mode_period
Sandbox - Multiple Rest Mode Period Documents
Sandbox___Multiple_rest_mode_period_Documents_v2_sandbox_usercollection_rest_mode_period_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/ring_configuration
Sandbox - Multiple Ring Configuration Documents
Sandbox___Multiple_ring_configuration_Documents_v2_sandbox_usercollection_ring_configuration_get 1 param → 200400401403429422
GET
/v2/sandbox/usercollection/daily_stress
Sandbox - Multiple Daily Stress Documents
Sandbox___Multiple_daily_stress_Documents_v2_sandbox_usercollection_daily_stress_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_resilience
Sandbox - Multiple Daily Resilience Documents
Sandbox___Multiple_daily_resilience_Documents_v2_sandbox_usercollection_daily_resilience_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/daily_cardiovascular_age
Sandbox - Multiple Daily Cardiovascular Age Documents
Sandbox___Multiple_daily_cardiovascular_age_Documents_v2_sandbox_usercollection_daily_cardiovascular_age_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/vO2_max
Sandbox - Multiple Vo2 Max Documents
Sandbox___Multiple_vO2_max_Documents_v2_sandbox_usercollection_vO2_max_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/tag/{document_id}
Sandbox - Single Tag Document
Sandbox___Single_tag_Document_v2_sandbox_usercollection_tag__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/enhanced_tag/{document_id}
Sandbox - Single Enhanced Tag Document
Sandbox___Single_enhanced_tag_Document_v2_sandbox_usercollection_enhanced_tag__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/workout/{document_id}
Sandbox - Single Workout Document
Sandbox___Single_workout_Document_v2_sandbox_usercollection_workout__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/session/{document_id}
Sandbox - Single Session Document
Sandbox___Single_session_Document_v2_sandbox_usercollection_session__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_activity/{document_id}
Sandbox - Single Daily Activity Document
Sandbox___Single_daily_activity_Document_v2_sandbox_usercollection_daily_activity__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_sleep/{document_id}
Sandbox - Single Daily Sleep Document
Sandbox___Single_daily_sleep_Document_v2_sandbox_usercollection_daily_sleep__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_spo2/{document_id}
Sandbox - Single Daily Spo2 Document
Sandbox___Single_daily_spo2_Document_v2_sandbox_usercollection_daily_spo2__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_readiness/{document_id}
Sandbox - Single Daily Readiness Document
Sandbox___Single_daily_readiness_Document_v2_sandbox_usercollection_daily_readiness__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/sleep/{document_id}
Sandbox - Single Sleep Document
Sandbox___Single_sleep_Document_v2_sandbox_usercollection_sleep__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/sleep_time/{document_id}
Sandbox - Single Sleep Time Document
Sandbox___Single_sleep_time_Document_v2_sandbox_usercollection_sleep_time__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/rest_mode_period/{document_id}
Sandbox - Single Rest Mode Period Document
Sandbox___Single_rest_mode_period_Document_v2_sandbox_usercollection_rest_mode_period__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/ring_configuration/{document_id}
Sandbox - Single Ring Configuration Document
Sandbox___Single_ring_configuration_Document_v2_sandbox_usercollection_ring_configuration__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_stress/{document_id}
Sandbox - Single Daily Stress Document
Sandbox___Single_daily_stress_Document_v2_sandbox_usercollection_daily_stress__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_resilience/{document_id}
Sandbox - Single Daily Resilience Document
Sandbox___Single_daily_resilience_Document_v2_sandbox_usercollection_daily_resilience__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/daily_cardiovascular_age/{document_id}
Sandbox - Single Daily Cardiovascular Age Document
Sandbox___Single_daily_cardiovascular_age_Document_v2_sandbox_usercollection_daily_cardiovascular_age__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/vO2_max/{document_id}
Sandbox - Single Vo2 Max Document
Sandbox___Single_vO2_max_Document_v2_sandbox_usercollection_vO2_max__document_id__get 1 param → 200404400401403429422
GET
/v2/sandbox/usercollection/heartrate
Sandbox - Multiple Heartrate Documents
Sandbox___Multiple_heartrate_Documents_v2_sandbox_usercollection_heartrate_get 3 params → 200400401403429422
GET
/v2/sandbox/usercollection/ring_battery_level
Sandbox - Multiple Ring Battery Level Documents
Sandbox___Multiple_ring_battery_level_Documents_v2_sandbox_usercollection_ring_battery_level_get 3 params → 200400401403429422

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are PublicModifiedSleepModel (32 properties), PublicDailyActivity (26 properties), PublicWorkout (10 properties), PublicReadinessContributors (9 properties). Each schema is shown below with its type and property counts.

MultiDocumentResponse_PublicRestModePeriod_
object
2 properties 2 required
MultiDocumentResponse_PublicSleepTime_
object
2 properties 2 required
PublicVO2Max
object
VO2Max estimate.
4 properties 4 required
MultiDocumentResponse_PublicDailyReadiness_
object
2 properties 2 required
MultiDocumentResponse_PublicDailyStress_
object
2 properties 2 required
PublicSleepTimeRecommendation
string
Possible public SleepTime recommendation.
PublicSleepTimeStatus
string
Possible public SleepTime status.
PublicDailyStressSummary
string
Possible public daily stress summary types.
MultiDocumentResponse_PublicVO2Max_
object
2 properties 2 required
ISODate
string
MultiDocumentResponse_EnhancedTagModel_
object
2 properties 2 required
PublicRingHardwareType
string
Possible ring hardware types.
PublicRingBatteryLevelRow
object
Object defining a ring battery level event.
5 properties 3 required
PublicRestModePeriod
object
Rest mode episode information.
6 properties 3 required
LongTermResilienceLevel
string
Possible long term resilience level values.
MultiDocumentResponse_PublicRingConfiguration_
object
2 properties 2 required
PublicDailySpO2
object
Daily SpO2 (Oxygen saturation).
4 properties 2 required
PublicDailySleep
object
Public object defining daily sleep.
5 properties 4 required
PublicWorkout
object
Public model for Workout.
10 properties 7 required
TimeSeriesResponseDict
object
2 properties 1 required
PublicRingDesign
string
Possible ring designs.
PublicSpo2AggregatedValues
object
Object defining public spo2 aggregated values.
1 property 1 required
DailyResilienceModel
object
4 properties 4 required
PublicWorkoutSource
string
Possible workout sources.
PublicRingConfiguration
object
Ring configuration.
7 properties 1 required
PublicSample
object
Object defining a recorded sample.
3 properties 3 required
PublicSleepType
string
Possible sleep period types. 'deleted' = deleted sleep by user. 'sleep' = user confirmed sleep / nap, min 15 minutes, max 3 hours, contributes to daily scores…
PublicRingColor
string
Possible ring colors.
PublicDailyCardiovascularAge
object
Daily Cardiovascular Age.
4 properties 2 required
PublicHeartRateRow
object
Heart rate sample
4 properties 4 required
ValidationError
object
3 properties 3 required
PublicMomentMood
string
Possible Moment moods.
Array_Union_float__NoneType__Bits64_
array
MultiDocumentResponse_PublicDailySleep_
object
2 properties 2 required
MultiDocumentResponseDict
object
2 properties 2 required
MultiDocumentResponse_PublicSession_
object
2 properties 2 required
PublicHeartRateSource
string
Possible heart rate sources.
PublicSession
object
Public model defining a recorded Session.
9 properties 5 required
MultiDocumentResponse_TagModel_
object
2 properties 2 required
TimeSeriesResponse_PublicRingBatteryLevelRow_
object
2 properties 1 required
PublicSleepTimeWindow
object
Object defining sleep time window
3 properties 3 required
PublicSleepAnalysisReason
string
Possible sleep analysis reasons.
MultiDocumentResponse_PublicDailyCardiovascularAge_
object
2 properties 2 required
MultiDocumentResponse_PublicWorkout_
object
2 properties 2 required
PublicDailyActivity
object
Object defining a daily activity that is a 24-hour period starting at 4 a.m.
26 properties 24 required
PublicReadinessContributors
object
Object defining readiness score contributors.
9 properties
MultiDocumentResponse_PublicDailyActivity_
object
2 properties 2 required
UtcDateTime
string
PublicDailyReadiness
object
Public object defining daily readiness.
7 properties 4 required
MultiDocumentResponse_PublicDailySpO2_
object
2 properties 2 required
PublicSleepAlgorithmVersion
string
Oura Sleep Staging Algorithms. v1 = original aka legacy aka OSSA 1.0, v2 = latest sleep algorithm
TimeSeriesResponse_PublicHeartRateRow_
object
2 properties 1 required
EnhancedTagModel
object
An EnhancedTagModel maps an ASSATag. An ASSATag in ExtAPIV2 is called a EnhancedTag An EnhancedTagModel will be populated by data from an ASSATag The fields in…
8 properties 3 required
PublicWorkoutIntensity
string
Possible workout intensities.
TagModel
object
A TagModel maps to an ASSANote. An ASSANote in ExtAPIV2 is called a Tag A TagModel will be populated by data from an ASSANote The fields in the TagModel map to…
5 properties 5 required
PublicActivityContributors
object
Object defining activity score contributors.
6 properties
LocalizedDateTime
string
MultiDocumentResponse_PublicModifiedSleepModel_
object
2 properties 2 required
PublicMomentType
string
Possible Moment types.
PublicDailyStress
object
Daily stress.
5 properties 2 required
PublicModifiedSleepModel
object
32 properties 7 required
ResilienceContributors
object
3 properties 3 required
PublicSleepContributors
object
Object defining sleep score contributors.
7 properties
PublicRestModeEpisode
object
Object defining a public Rest Mode episode.
2 properties 2 required
LocalDateTime
string
PublicReadiness
object
Object defining readiness.
4 properties 1 required
HTTPValidationError
object
1 property
MultiDocumentResponse_DailyResilienceModel_
object
2 properties 2 required
PublicSleepTime
object
Suggested bedtime for the user.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oura-sandbox-routes-api-openapi.yml Raw ↑

Other APIs Oura Ring publishes across the network.

Oura Ring Daily Activity Routes API
Oura Ring Daily Cardiovascular Age Routes API
Oura Ring Daily Readiness Routes API
Oura Ring Daily Resilience Routes API
Oura Ring Daily Sleep Routes API
Oura Ring Daily Spo2 Routes API
Oura Ring Daily Stress Routes API
Oura Ring Enhanced Tag Routes API
Oura Ring Heart Rate Routes API
Oura Ring Personal Info Routes API
Oura Ring Rest Mode Period Routes API
Oura Ring Ring Battery Level Routes API
Where this information came from

This is an independent, third-party profile of Oura Ring Sandbox Routes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.