For an overview of the Oura API v2, check out this article.
The Oura API can be used to fetch your Oura data or build an integration that allows anyone to share their Oura data with a third-party service. If you're only interested in fetching your own data, read our section about Personal Access Tokens. To learn more about how to build an integration using an API Application, please visit the API documentation here.
Why did you release Oura API v2 instead of building on the Oura API v1?
What’s new in Oura API v2?
What’s the difference between the Oura API v1 and the Oura API v2?
Is data still accessible through the Oura API for Gen3 Oura Ring users who are no longer enrolled in Oura membership?
How long will Oura support Oura API v1?
Do you provide group access tokens?
What are your future improvement plans for the Oura API?
Will you offer push functionality or offer webhooks?
Do you offer a sandbox environment for developers who do not have an Oura Ring?
Get started with Personal Access Tokens
Using your Personal Access Token
Why did you release Oura API v2 instead of building on the Oura API v1?
Since the release of Oura API v1 several years ago, Oura has evolved its backend data models to better reflect how the product has evolved. The Oura API v2 is designed to interface with these new data models, which will enable new functionality and more data endpoints.
What’s new in Oura API v2?
The goal is to make it easier and more valuable to integrate with Oura. In this first release of the Oura API v2, we provide access to new data endpoints that do not exist in the Oura API v1, including daytime heart rate measurement for Gen3 rings, biometric trend data from Explore tab sessions, tags, and workouts. It also comes with improved documentation that includes inline code examples to make it easier to get started with the Oura API.
What’s the difference between the Oura API v1 and the Oura API v2?
This article outlines the differences between the Oura API v1 and the Oura API v2.
Is data still accessible through the Oura API for Gen3 Oura Ring users who are no longer enrolled in Oura Membership?
No — Gen3 Oura Ring users who are no longer enrolled in the Oura Membership will no longer have their data accessible through the Oura API. Furthermore, partner applications that are integrated with the Oura API will no longer have access to the data of Oura Ring Generation 3 users that are no longer enrolled in the Oura Membership. However, all Oura users will still be able to easily download their data files through Oura on the Web in the Export Data section of the My Account page. At a minimum, these data files will comply with GDPR request requirements.
Oura Ring Generation 2 users will not experience any changes to the availability of their data through the Oura API.
How long will Oura support Oura API v1?
Oura is planning to support the Oura API v1 for at least one year after the release of the Oura API v2 in January 2022.
Do you provide group access tokens?
We do not currently provide group access tokens but are considering this for the future.
What are your future improvement plans for the Oura API?
We’re always improving, striving to make the Oura API easier and more valuable to integrate with. We will continue to introduce new functionality and new data, including new data types for the Oura Ring Generation 3 as they become available (e.g. workout heart rate, oxygen-related metrics).
Will you offer push functionality or offer webhooks?
Currently, partners are only able to pull data from the Oura API. In 2022, we are planning to add push functionality and webhooks.
Do you offer a sandbox environment for developers who do not have an Oura Ring?
Currently, partners must have access to data from an Oura Ring to test use cases with the Oura API. In 2022, we plan to add a sandbox environment so partners can test commands with sample data without needing to possess an Oura Ring.
Get Started with Personal Access Tokens
Oura also offers personal access tokens for easier integration with the Oura Cloud API. These personal access tokens make integration easier for developers who want to programmatically fetch their Oura data from Oura's Cloud API.
To get started with these personal access tokens, follow the steps below:
- Navigate to the Personal Access Tokens page.
- In the upper-right corner of the page click the "Create A New Personal Access Token"
- Enter a unique note for the new Personal Access Token you are about to generate
- Click "Create Personal Access Token" to submit the form and create your new personal access token
You should now have a new access token listed on the Personal Access Tokens page.
Be sure to copy this new token as you will not be able to view the token once you’ve navigated from this page. Click "Copy" to copy the token value to your clipboard.
Using Your Personal Access Token
Once you've acquired your personal access token, it can be used to access the Oura API. There are two ways of providing the Personal Access Token:
-
HTTP header: Include the personal access token in the authorization header like this:
GET /v1/userinfo HTTP/1.1
Host: api.ouraring.com
Authorization: Bearer PHCW3OVMXQZX5FJUR6ZK4FAA2MK2CWWA -
URL parameter: Add access_token parameter to the API call:
https://api.ouraring.com/v1/userinfo?access_token=PHCW3OVMXQZX5FJUR6ZK4FAA2MK2CWWA
You can revoke your personal access tokens at any time.
