Skip to content

Single Workout Document

GET
/v2/usercollection/workout/{document_id}
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/workout/2-5daccc095220cc5493a4e9c2b681ca941e' \
--header 'Authorization: Bearer <token>'
document_id
required
Document Id
string

Successful Response

Media typeapplication/json
PublicWorkout

Public model for Workout.

object
id
required

Unique identifier of the object.

string
>= 1 characters
activity
required

Type of the workout activity.

string
calories
Any of:
number
day
required

Day when the workout occurred.

string
distance
Any of:
number
end_datetime
required

Timestamp indicating when the workout ended.

string
intensity
required

Intensity of the workout.

string
Allowed values: easy moderate hard
label
Any of:
string
source
required

Possible workout sources.

string
Allowed values: manual autodetected confirmed workout_heart_rate
start_datetime
required

Timestamp indicating when the workout started.

string
Example
{
"intensity": "easy",
"source": "manual"
}

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>
ValidationError
object
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.