User
Get User
GET User details given the user_id.
GET
/
v2
/
user
/
{user_id}
Authorization
Path
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"
}
}
Authorizations
x-vital-api-key
string
headerrequiredAPI key based authentication
Path Parameters
user_id
string
requiredResponse
200 - application/json
client_user_id
string
requiredA 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.
connected_sources
object[]
requiredA list of the users connected sources.
created_on
string
requiredWhen your item is created
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).
team_id
string
requiredYour team id.
user_id
string
requiredUser 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.
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"
}
}