Vital Summary API

The summary API from Vital — 15 operation(s) for summary.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 15 operations across 15 paths, and defines 103 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.

15 operations 15 paths 103 schemas 15 GET

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.2.0

API Version

1.0

Base URL

https://api.us.junction.com

Authentication

API Key

Resource Areas

Authentication & Security 1

Vital Summary API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-vital-api-key (apiKeyAuth). By default, every request must be authenticated.

apiKeyAuth — Vital Team API Key

Paths & Operations 15

Across 15 paths, the API surfaces 15 operations — 15 GET. Each is listed below with its method, path, parameters, and response codes.

Summary 15

GET

/v2/summary/electrocardiogram/{user_id}

Get User Electrocardiogram

get_user_electrocardiogram_v2_summary_electrocardiogram__user_id__get 4 params → 200422

GET

/v2/summary/sleep_cycle/{user_id}

Get User Sleep Cycle

get_user_sleep_cycle_v2_summary_sleep_cycle__user_id__get 4 params → 200422

GET

/v2/summary/profile/{user_id}

Get User Profile

get_user_profile_v2_summary_profile__user_id__get 2 params → 200422

GET

/v2/summary/profile/{user_id}/raw

Get User Profile Raw

get_user_profile_raw_v2_summary_profile__user_id__raw_get 2 params → 200422

GET

/v2/summary/devices/{user_id}/raw

Get User Devices Raw

get_user_devices_raw_v2_summary_devices__user_id__raw_get 2 params → 200422

GET

/v2/summary/activity/{user_id}

Get User Activity

get_user_activity_v2_summary_activity__user_id__get 4 params → 200422

GET

/v2/summary/activity/{user_id}/raw

Get User Activity Raw

get_user_activity_raw_v2_summary_activity__user_id__raw_get 4 params → 200422

GET

/v2/summary/workouts/{user_id}

Get User Workouts

get_user_workouts_v2_summary_workouts__user_id__get 4 params → 200422

GET

/v2/summary/workouts/{user_id}/raw

Get User Workouts Raw

get_user_workouts_raw_v2_summary_workouts__user_id__raw_get 4 params → 200422

GET

/v2/summary/sleep/{user_id}

Get User Sleep

get_user_sleep_v2_summary_sleep__user_id__get 4 params → 200422

GET

/v2/summary/sleep/{user_id}/raw

Get User Sleep Raw

get_user_sleep_raw_v2_summary_sleep__user_id__raw_get 4 params → 200422

GET

/v2/summary/body/{user_id}

Get User Body

get_user_body_v2_summary_body__user_id__get 4 params → 200422

GET

/v2/summary/body/{user_id}/raw

Get User Body Raw

get_user_body_raw_v2_summary_body__user_id__raw_get 4 params → 200422

GET

/v2/summary/meal/{user_id}

Get Meals

get_meals_v2_summary_meal__user_id__get 4 params → 200422

GET

/v2/summary/menstrual_cycle/{user_id}

Get User Menstrual Cycles

get_user_menstrual_cycles_v2_summary_menstrual_cycle__user_id__get 4 params → 200422

Schemas 103

The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are ClientFacingSleep (36 properties), ClientFacingSleep_2 (31 properties), ClientFacingWorkout (29 properties), ClientFacingMenstrualCycle (23 properties). Each schema is shown below with its type and property counts.

ClientFacingHeartRateTimeseries

object

6 properties 3 required

ClientBodyResponse

object

1 property 1 required

ClientFacingSport

object

3 properties 3 required

ClientFacingShallowWorkoutStream

object

6 properties 4 required

ClientFacingDevice

object

9 properties 4 required

ClientFacingActivity

object

21 properties 7 required

ClientFacingSleepCycleChanged

object

5 properties 5 required

ClientFacingFood

object

3 properties

BasalBodyTemperatureEntry

object

2 properties 2 required

ClientFacingSource

object

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

6 properties 1 required

ClientFacingProfile

object

10 properties 5 required

ClientFacingSleepCycleHistoricalPullCompleted

object

5 properties 5 required

ClientFacingWorkoutMap

object

2 properties

ClientFacingMenstrualCycleChanged

object

5 properties 5 required

ClientFacingProvider

object

A vendor, a service, or a platform which Vital can connect with.

3 properties 3 required

ClientFacingWorkoutStreamChanged

object

5 properties 5 required

ClientFacingMealHistoricalPullCompleted

object

5 properties 5 required

ClientFacingSleepHistoricalPullCompleted

object

5 properties 5 required

RawActivity

object

11 properties 8 required

RawSleepResponse

object

1 property 1 required

ClientFacingBodyChanged

object

5 properties 5 required

Sex

string

ℹ️ This enum is non-exhaustive.

ClientFacingHRVTimeseries

object

6 properties 3 required

ClientFacingBodyHistoricalPullCompleted

object

5 properties 5 required

ClientFacingProfileChanged

object

5 properties 5 required

HTTPValidationError

object

1 property

MenstrualCycleResponse

object

1 property 1 required

RawWorkoutResponse

object

1 property 1 required

ClientFacingMenstrualCycleHistoricalPullCompleted

object

5 properties 5 required

ClientFacingBody

object

16 properties 7 required

Micros

object

3 properties

Providers

string

ℹ️ This enum is non-exhaustive.

ClientSleepCycleResponse

object

1 property 1 required

Gender

string

ℹ️ This enum is non-exhaustive.

CervicalMucusEntry

object

2 properties 2 required

ClientFacingWorkoutsHistoricalPullCompleted

object

5 properties 5 required

ClientFacingProfileHistoricalPullCompleted

object

5 properties 5 required

ClientFacingMealResponse

object

1 property 1 required

IntermenstrualBleedingEntry

object

1 property 1 required

ClientFacingElectrocardiogram

object

19 properties 10 required

Vitamins

string

ℹ️ This enum is non-exhaustive.

ClientFacingMealChanged

object

5 properties 5 required

Macros

object

8 properties

RawBodyResponse

object

1 property 1 required

Fats

object

6 properties

ClientFacingHeartRate

object

5 properties

ClientFacingSleepStream

object

3 properties

DetectedDeviationEntry

object

2 properties 2 required

RawWorkout

object

13 properties 10 required

ClientFacingWorkoutsChanged

object

5 properties 5 required

ContraceptiveEntry

object

2 properties 2 required

MenstrualFlowEntry

object

2 properties 2 required

ClientFacingElectrocardiogramResponse

object

1 property 1 required

ClientFacingRespiratoryRateTimeseries

object

6 properties 3 required

ClientActivityResponse

object

1 property 1 required

ClientFacingActivityHistoricalPullCompleted

object

5 properties 5 required

ClientFacingElectrocardiogramHistoricalPullCompleted

object

5 properties 5 required

MealInDBBase_ClientFacingSource_

object

17 properties 14 required

Energy

object

2 properties 2 required

ClientFacingMenstrualCycle

object

23 properties 8 required

ClientFacingWorkoutStreamHistoricalPullCompleted

object

5 properties 5 required

VitalSleepStage

integer

ℹ️ This enum is non-exhaustive.

SleepType

string

ℹ️ This enum is non-exhaustive.

ClientFacingSleepChanged

object

5 properties 5 required

ProfileInDb

object

8 properties 5 required

HomePregnancyTestEntry

object

2 properties 2 required

TraceElements

string

ℹ️ This enum is non-exhaustive.

RawDevicesResponse

object

1 property 1 required

ClientSleepResponse

object

1 property 1 required

ClientFacingWorkout

object

29 properties 9 required

HomeProgesteroneTestEntry

object

2 properties 2 required

SleepSummaryState

string

ℹ️ This enum is non-exhaustive.

RawActivityResponse

object

1 property 1 required

ClientFacingElectrocardiogramChanged

object

5 properties 5 required

ClientFacingSleep

object

36 properties 16 required

RawSleep

object

12 properties 8 required

OvulationTestEntry

object

2 properties 2 required

ClientFacingActivityChanged

object

5 properties 5 required

ClientWorkoutResponse

object

1 property 1 required

ClientFacingDeviceChanged

object

5 properties 5 required

RawDevice

object

6 properties 6 required

RawProfile

object

1 property 1 required

HistoricalPullCompleted

object

4 properties 4 required

ClientFacingSleepCycle

object

16 properties 13 required

Minerals

string

ℹ️ This enum is non-exhaustive.

RawBody

object

12 properties 8 required

SexualActivityEntry

object

2 properties 1 required

Labs

string

ℹ️ This enum is non-exhaustive.

ClientBodyResponse_2

object

1 property 1 required

ClientFacingShallowWorkoutStream_2

object

6 properties 4 required

ClientFacingActivity_2

object

21 properties 7 required

ClientFacingSource_2

object

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

9 properties 1 required

ClientFacingProfile_2

object

10 properties 5 required

ClientFacingHRVTimeseries_2

object

6 properties 3 required

ClientFacingHypnogramTimeseries

object

8 properties 5 required

ClientFacingBody_2

object

16 properties 7 required

Micros_2

object

3 properties

Providers_2

string

ℹ️ This enum is non-exhaustive.

ClientFacingSleepStream_2

object

4 properties

ClientActivityResponse_2

object

1 property 1 required

ClientFacingSleep_2

object

31 properties 16 required

HistoricalPullCompleted_2

object

5 properties 5 required

Labs_2

string

ℹ️ This enum is non-exhaustive.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Summary

← Back to V APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=vital-io-summary-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/vital-io-summary-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Vital Summary API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Vital Summary API

Metadata

Authentication & Security 1

Paths & Operations 15

Schemas 103

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key