Get Teams Users

User

Get Teams Users

GET

/v2/user

x-vital-api-key*

curl --request GET \
  --url https://api.tryvital.io/v2/user \
  --header 'x-vital-api-key: <x-vital-api-key>'

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
}

Query Parameters

offsetDefault: "0"

integer

Offset

limitDefault: "100"

integer

Limit

Response

limitrequired

integer

Limit

offsetrequired

integer

Offset

totalrequired

integer

Total

usersrequired

array

client_user_idrequired

string

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.

connected_sourcesrequired

array

A list of the users connected sources.

created_onrequired

string

When 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).

idrequired

string

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).

source_slugrequired

string

Slug for designated source

updated_atrequired

string

Updated At

team_idrequired

string

Your team id.

user_idrequired

string

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.

user_key

string

User key returned by vital create user key request. This key 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/ \
     --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
}

User

Providers

Link

Sleep

Meal

Workouts

Profile

Activity

Body

Vitals

Lab Testing

Lab Testing - At-home Phlebotomy

Lab Tests

Results

​Query Parameters

​Response

Query Parameters

Response