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

{
  "user_id": "409d9870-21fb-443a-8daa-c5222659f40e",
  "team_id": "3aac677c-557f-40b7-9251-0315c1f48e77",
  "client_user_id": "d734e32e-dd43-4b77-ab56-692524279531",
  "connected_sources": [
    {
      "source": {
        "name": "Oura",
        "slug": "oura",
        "logo": "logo_url"
      },
      "created_on": "2022-08-04T12:42:45.596792+00:00"
    }
  ],
  "fallback_time_zone": {
    "id": "Europe/London",
    "source_slug": "manual",
    "updated_at": "2022-09-11T13:45:56+00:00"
  },
  "fallback_birth_date": {
    "value": "1980-03-13",
    "source_slug": "manual",
    "updated_at": "2022-09-11T13:45:56+00:00"
  }
}

Authorizations

x-vital-api-key
string
headerrequired

API key based authentication

Path Parameters

user_id
string
required

Response

200 - application/json
user_id
string
required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

team_id
string
required

Your team id.

client_user_id
string
required

A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

created_on
string
required

When your item is created

connected_sources
object[]
required

A list of the users connected sources.

fallback_time_zone
object
Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
fallback_birth_date
object

Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age.

ingestion_start
string

Starting bound for user data ingestion. Data older than this date will not be ingested.

ingestion_end
string

Ending bound for user data ingestion. Data newer than this date will not be ingested and the connection deregistered.

Create UserGet User by Client User ID