Single Ring Configuration Document
GET
/v2/usercollection/ring_configuration/{document_id}
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/ring_configuration/2-5daccc095220cc5493a4e9c2b681ca941e' \--header 'Authorization: Bearer <token>'import requestsurl = 'https://api.ouraring.com/v2/usercollection/ring_configuration/2-5daccc095220cc5493a4e9c2b681ca941e'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/2-5daccc095220cc5493a4e9c2b681ca941e', 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/2-5daccc095220cc5493a4e9c2b681ca941e") .method("GET", null) .addHeader("Authorization", "Bearer <token>") .build();Response response = client.newCall(request).execute();Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”document_id
required
Document Id
string
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
PublicRingConfiguration
Ring configuration.
object
id
required
Unique identifier of the object.
string
color
Any of:
PublicRingColor
Possible ring colors.
string
null
design
Any of:
PublicRingDesign
Possible ring designs.
string
null
hardware_type
Any of:
PublicRingHardwareType
Possible ring hardware types.
string
null
Example
{ "color": "brushed_silver", "design": "heritage", "hardware_type": "gen1"}Client Exception
Unauthorized access exception. Usually means the access token is expired, malformed or revoked.
Access forbidden. Usually means the user’s subscription to Oura has expired and their data is not available via the API.
Not Found
Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}Request Rate Limit Exceeded.