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

{
  "body": [
    {
      "body_mass_index": 22.3,
      "bone_mass_percentage": 4.3,
      "calendar_date": "2023-02-27",
      "created_at": "2023-02-27T20:31:24+00:00",
      "date": "2023-02-27T12:31:24+00:00",
      "fat": 30,
      "height": 183,
      "id": "8be1306e-01fc-46b1-b5d1-a9e39052db09",
      "lean_body_mass_kilogram": 40.1,
      "muscle_mass_percentage": 40.2,
      "source": {
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "logo": "https://logo_url.com",
        "name": "Withings",
        "slug": "withings"
      },
      "updated_at": "2023-02-28T01:22:38+00:00",
      "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
      "visceral_fat_index": 4.5,
      "waist_circumference_centimeter": 86.36,
      "water_percentage": 55.4,
      "weight": 80
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://vital-mintlify-seo-descriptions-1777051001.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

curl --request GET \
     --url {{BASE_URL}}/v2/summary/body/{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

​
start_date
string
required

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

​
end_date
string | null

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Response

Successful Response

​
body
ClientFacingBody · object[]
required