Multiple Ring Configuration Documents

GET

/v2/usercollection/ring_configuration

curl --location --request GET 'https://api.ouraring.com/v2/usercollection/ring_configuration?fields=day,score' \
--header 'Authorization: Bearer <token>'

import requests
url = 'https://api.ouraring.com/v2/usercollection/ring_configuration'
params = {'fields': 'day,score'}
headers = {
  'Authorization': 'Bearer <token>'
}
response = requests.request('GET', url, headers=headers, params=params)
print(response.text)

var myHeaders = new Headers();
myHeaders.append('Authorization', 'Bearer <token>');
var requestOptions = {
  method: 'GET',
  headers: myHeaders,
};
fetch('https://api.ouraring.com/v2/usercollection/ring_configuration?fields=day,score', requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api.ouraring.com/v2/usercollection/ring_configuration?fields=day,score")
  .method("GET", null)
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();

Authorizations

BearerAuth

Parameters

Query Parameters

fields

Any of:

string
null

string

Comma-separated list of fields to include in the response, in addition to the always returned fields. Defaults to all fields if not provided.

next_token

Any of:

string
null

string

Responses

200

Successful Response

application/json

MultiDocumentResponse[PublicRingConfiguration]

object

data

required

Data

Array<object>

PublicRingConfiguration

Ring configuration.

object

required

Unique identifier of the object.

string

>= 1 characters

color

Any of:

PublicRingColor
null

PublicRingColor

Possible ring colors.

string

Allowed values: brushed_silver glossy_black glossy_gold glossy_white gucci matt_gold rose silver stealth_black titanium titanium_and_gold cloud petal midnight tide deep_rose

design

Any of:

PublicRingDesign
null

PublicRingDesign

Possible ring designs.

string

Allowed values: heritage balance balance_diamond horizon ceramic

firmware_version

Any of:

string
null

string

hardware_type

Any of:

PublicRingHardwareType
null

PublicRingHardwareType

Possible ring hardware types.

string

Allowed values: gen1 gen2 gen2m gen3 gen4 or5

set_up_at

Any of:

string
null

string

size

Any of:

integer
null

integer

next_token

required

Any of:

string
null

string

Example

{
  "data": [
    {
      "color": "brushed_silver",
      "design": "heritage",
      "hardware_type": "gen1"
    }
  ]
}

400

Client Exception

401

Unauthorized access exception. Usually means the access token is expired, malformed or revoked.

403

Access forbidden. Usually means the user’s subscription to Oura has expired and their data is not available via the API.

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

429

Request Rate Limit Exceeded.

Multiple Ring Configuration Documents

Authorizations

Parameters

Query Parameters

Responses

200

Example

400

401

403

422

Examplegenerated

429

Example^generated