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 Rest Mode Period Routes API

The Rest Mode scope includes information about rest mode periods. This includes the start, end time and detaials of the rest mode period.

Oura Ring Rest Mode Period 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 Rest Mode Period Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 8 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.

2 operations 2 paths 8 schemas 2 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 Rest Mode Period 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 2

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

Rest Mode Period Routes 2

The Rest Mode scope includes information about rest mode periods. This includes the start, end time and detaials of the rest mode period.

GET
/v2/usercollection/rest_mode_period
Multiple Rest Mode Period Documents
Multiple_rest_mode_period_Documents_v2_usercollection_rest_mode_period_get 4 params → 200400401403429422
GET
/v2/usercollection/rest_mode_period/{document_id}
Single Rest Mode Period Document
Single_rest_mode_period_Document_v2_usercollection_rest_mode_period__document_id__get 1 param → 200404400401403429422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PublicRestModePeriod (6 properties), ValidationError (3 properties), MultiDocumentResponseDict (2 properties), PublicRestModeEpisode (2 properties). Each schema is shown below with its type and property counts.

LocalizedDateTime
string
ISODate
string
PublicRestModePeriod
object
Rest mode episode information.
6 properties 3 required
PublicRestModeEpisode
object
Object defining a public Rest Mode episode.
2 properties 2 required
ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
MultiDocumentResponseDict
object
2 properties 2 required
MultiDocumentResponse_PublicRestModePeriod_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oura-rest-mode-period-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 Ring Battery Level Routes API
Oura Ring Ring Configuration Routes API
Where this information came from

This is an independent, third-party profile of Oura Ring Rest Mode Period 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.