Multiple Workout Documents

GET

/v2/usercollection/workout

curl --location --request GET 'https://api.ouraring.com/v2/usercollection/workout?start_date=2021-11-01&end_date=2021-12-01&fields=day,score' \
--header 'Authorization: Bearer <token>'

• Oura API

Authorizations

• BearerAuth

Parameters

Query Parameters

start_date

Start Date

string format: date

end_date

End Date

string format: date

next_token

Any of:

string

string

null

null

fields

Any of:

string

string

null

null

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

Responses

200

Successful Response

Media typeapplication/json

MultiDocumentResponse[PublicWorkout]

object

data

required

Data

Array<object>

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

number

null

null

day

required

Day when the workout occurred.

string

distance

Any of:

number

number

null

null

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

string

null

null

source

required

Possible workout sources.

string

Allowed values: manual autodetected confirmed workout_heart_rate

start_datetime

required

Timestamp indicating when the workout started.

string

next_token

required

Any of:

string

string

null

null

Example

{
  "data": [
    {
      "intensity": "easy",
      "source": "manual"
    }
  ]
}

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

Media typeapplication/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.