Skip to main content
GET
/
v2
/
summary
/
profile
/
{user_id}
curl --request GET \
     --url {{BASE_URL}}/v2/summary/profile/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "created_at": "2023-02-27T20:31:24+00:00",
  "height": 183,
  "id": "ceb39d90-5ba6-472b-9cb8-b5c128da5038",
  "source": {
    "logo": "https://logo_url.com",
    "name": "Oura",
    "slug": "oura"
  },
  "updated_at": "2023-02-28T01:22:38+00:00",
  "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
curl --request GET \
     --url {{BASE_URL}}/v2/summary/profile/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
user_id
string<uuid>
required

Query Parameters

​
provider
string
default:""

Provider oura/strava etc

Response

Successful Response

​
id
string<uuid>
required
​
user_id
string<uuid>
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.

​
source
object
required

Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.

Example:
{ "provider": "oura", "type": "ring" }
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
height
integer | null
​
birth_date
string<date> | null
​
wheelchair_use
boolean | null
​
gender
enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options:
female,
male,
other,
unknown
​
sex
enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options:
female,
male,
other