Skip to main content
GET
/
v2
/
user
curl --request GET \
     --url {{BASE_URL}}/v2/user/ \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "users": [
    {
      "client_user_id": "ZTEwZjNjMjctOTI2ZS00M2Vm",
      "connected_sources": [
        {
          "created_on": "2026-03-26T14:15:58+00:00",
          "source": {
            "logo": "logo_url",
            "name": "Oura",
            "slug": "oura"
          }
        }
      ],
      "created_on": "2026-03-26T14:15:58+00:00",
      "fallback_birth_date": {
        "source_slug": "manual",
        "updated_at": "2026-03-26T14:15:58+00:00",
        "value": "1989-09-12"
      },
      "fallback_time_zone": {
        "id": "Europe/London",
        "source_slug": "manual",
        "updated_at": "2026-03-26T14:15:58+00:00"
      },
      "team_id": "56bd81c9-6219-4000-a775-ae85526eba18",
      "user_id": "56bd81c9-6219-4000-a775-ae85526eba18"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}
curl --request GET \
     --url {{BASE_URL}}/v2/user/ \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Query Parameters

​
offset
integer
default:0
​
limit
integer
default:100
Required range: x <= 500

Response

Successful Response

​
users
User · object[]
required
​
total
integer
required
​
offset
integer
required
​
limit
integer
required