Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://production.api.onvy.health/users \
  --header 'X-API-Key: <api-key>'
{
  "users": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "language": "<string>",
      "tz_offset": 123,
      "firstname": "<string>",
      "lastname": "<string>",
      "measurement_unit": "metric",
      "gender": "male",
      "birthday": "2023-12-25",
      "height": 123,
      "weight": 123,
      "thresholds": {
        "ftp": 123,
        "lthr": 123,
        "mhr": 123
      },
      "location": {
        "lat": 123,
        "lon": 123
      },
      "coach_config": {
        "enabled": true
      },
      "data_syncs": [
        {
          "data_type": "auth",
          "sync_type": "historical",
          "provider": "GARMIN",
          "status": "pending",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 500,
    "total": 1,
    "page": "<string>",
    "next_page": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

page
string

Page Key for pagination

limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000

Response

Successful response

users
User · object[]
required
pagination
Pagination · object
required