What Is the Oura API?
The Oura API V1 was released in 2016 and the Oura API V2 released in January 2022. Support for V1 was discontinued in early 2023.
How to Use the Oura API
Gen3 Oura Ring users without active Oura Membership will no longer be able to access their data 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 who do not have active Oura Membership. However, all Oura users will still be able to easily download their data files through Oura on the Web. At a minimum, these data files will comply with GDPR request requirements.
Oura users must have updated to a recent version of the Oura mobile app to support new data types that are available through the Oura API V2.
Existing access tokens from the Oura API V1 will remain valid for use with the Oura API V2 for personal information, daily activity, daily readiness, daily sleep, and bedtime data. Existing access tokens from the Oura API V1 will not have access to any new data types available through the Oura API V2, including daytime heart rate measurement, workout heart rate, workouts, tags, sessions, and other data types that will be released in the future. For access to new data types provided by the Oura API V2, you can either create new personal access tokens or ask users to consent to new data scopes via the OAuth authorization flow.
Oura Ring Generation 2 users will not experience any changes to the availability of their data through the Oura API.
How to Generate 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. We do not currently provide group access tokens.
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.
How to Use Personal Access Tokens
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
Authorization: Bearer PHCW3OVMXQZX5FJUR6ZK4FAA2MK2CWWA
URL parameter: Add access_token parameter to the API call:
You can revoke your personal access tokens at any time.