User Management
Vital Mobile SDK Integration
Device Connections
Get Teams Users
GET All users for team.
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": "2025-04-17T12:26:09+00:00",
"source": {
"logo": "logo_url",
"name": "Oura",
"slug": "oura"
}
}
],
"created_on": "2025-04-17T12:26:09+00:00",
"fallback_birth_date": {
"source_slug": "manual",
"updated_at": "2025-04-17T12:26:09+00:00",
"value": "1989-09-12"
},
"fallback_time_zone": {
"id": "Europe/London",
"source_slug": "manual",
"updated_at": "2025-04-17T12:26:09+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
Vital Team API Key
Response
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.
Your team id.
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.
When your item is created
A list of the users connected sources.
The provider of this connected source.
{
"logo": "https://logo_url.com",
"name": "Oura",
"slug": "oura"
}
When your item is created
Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.
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 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).
Slug for designated source
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.
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.
Slug for designated source
Starting bound for user data ingestion bounds.
Ending bound for user data ingestion bounds.
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": "2025-04-17T12:26:09+00:00",
"source": {
"logo": "logo_url",
"name": "Oura",
"slug": "oura"
}
}
],
"created_on": "2025-04-17T12:26:09+00:00",
"fallback_birth_date": {
"source_slug": "manual",
"updated_at": "2025-04-17T12:26:09+00:00",
"value": "1989-09-12"
},
"fallback_time_zone": {
"id": "Europe/London",
"source_slug": "manual",
"updated_at": "2025-04-17T12:26:09+00:00"
},
"team_id": "56bd81c9-6219-4000-a775-ae85526eba18",
"user_id": "56bd81c9-6219-4000-a775-ae85526eba18"
}
],
"total": 123,
"offset": 123,
"limit": 123
}