- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
Users
Debugging
Orders
At-home Phlebotomy
Tests
Results
Health Insurance
Sleep
Meal
Workouts
Profile
Activity
Body
Vitals
Body
Activity
Wellness
Nutrition
Team
Member
Invite
Org
Team API Keys
Team Custom Credentials
Team ETL Pipeline
Core
Lab Testing
Summary Data
Timeseries Data
Org Management
Get Teams Users
GET All users for team.
API key based authentication
curl --request GET \
--url {{BASE_URL}}/v2/user/ \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"users": [
{
"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"
}
]
}
],
"total": 1,
"offset": 0,
"limit": 100
}
Authorizations
API key based authentication
Query Parameters
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.
Name of source of information
Slug for designated source
URL for source logo
When your item is created
Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.
Name of source of information
Slug for designated source
URL for source logo
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. Data older than this date will not be ingested.
Ending bound for user data ingestion. Data newer than this date will not be ingested and the connection deregistered.
curl --request GET \
--url {{BASE_URL}}/v2/user/ \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"users": [
{
"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"
}
]
}
],
"total": 1,
"offset": 0,
"limit": 100
}