How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vital

Vital summary API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Vital summary API is one of 18 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Summary. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 15 operations across 15 paths, and defines 65 schemas. It is described by OpenAPI 3.1.0, at version 0.4.497.

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 65 schemas 15 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.497
Base URL
https://api.us.junction.com
Authentication
API Key
Contact
Junction (Vital) Support
Resource Areas
1

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 65

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

ClientFacingHeartRateTimeseries
object
6 properties 3 required
SleepSummaryState
string
ℹ️ This enum is non-exhaustive.
ClientFacingHRVTimeseries
object
6 properties 3 required
Gender
string
ℹ️ This enum is non-exhaustive.
ClientFacingSport
object
3 properties 3 required
ClientFacingElectrocardiogram
object
19 properties 10 required
Labs
string
ℹ️ This enum is non-exhaustive.
RawBodyResponse
object
1 property 1 required
HomePregnancyTestEntry
object
2 properties 2 required
ClientSleepCycleResponse
object
1 property 1 required
MealInDBBase_ClientFacingSource_
object
17 properties 14 required
Micros
object
3 properties
BasalBodyTemperatureEntry
object
2 properties 2 required
VitalSleepStage
integer
ℹ️ This enum is non-exhaustive.
DetectedDeviationEntry
object
2 properties 2 required
RawWorkout
object
13 properties 10 required
ClientFacingActivity
object
21 properties 7 required
ClientFacingProfile
object
10 properties 5 required
ClientFacingHypnogramTimeseries
object
8 properties 5 required
ClientFacingMenstrualCycle
object
23 properties 8 required
Vitamins
string
ℹ️ This enum is non-exhaustive.
CervicalMucusEntry
object
2 properties 2 required
ClientFacingWorkoutMap
object
2 properties
TraceElements
string
ℹ️ This enum is non-exhaustive.
Sex
string
ℹ️ This enum is non-exhaustive.
ClientFacingHeartRate
object
5 properties
ClientFacingElectrocardiogramResponse
object
1 property 1 required
RawDevicesResponse
object
1 property 1 required
MenstrualCycleResponse
object
1 property 1 required
ClientFacingSource
object
Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.
9 properties 1 required
RawDevice
object
6 properties 6 required
RawProfile
object
1 property 1 required
Providers
string
ℹ️ This enum is non-exhaustive.
Fats
object
6 properties
ClientSleepResponse
object
1 property 1 required
RawActivityResponse
object
1 property 1 required
HTTPValidationError
object
1 property
HomeProgesteroneTestEntry
object
2 properties 2 required
ContraceptiveEntry
object
2 properties 2 required
ClientFacingSleepCycle
object
16 properties 13 required
RawSleepResponse
object
1 property 1 required
SexualActivityEntry
object
2 properties 1 required
RawActivity
object
11 properties 8 required
RawBody
object
12 properties 8 required
ClientWorkoutResponse
object
1 property 1 required
OvulationTestEntry
object
2 properties 2 required
ClientFacingSleepStream
object
4 properties
Macros
object
8 properties
IntermenstrualBleedingEntry
object
1 property 1 required
RawSleep
object
12 properties 8 required
ClientFacingBody
object
16 properties 7 required
ClientFacingMealResponse
object
1 property 1 required
MenstrualFlowEntry
object
2 properties 2 required
ClientFacingSleep
object
31 properties 16 required
RawWorkoutResponse
object
1 property 1 required
ProfileInDb
object
8 properties 5 required
Minerals
string
ℹ️ This enum is non-exhaustive.
ClientFacingProvider
object
A vendor, a service, or a platform which Vital can connect with.
3 properties 3 required
ClientBodyResponse
object
1 property 1 required
ClientActivityResponse
object
1 property 1 required
ClientFacingFood
object
3 properties
SleepType
string
ℹ️ This enum is non-exhaustive.
ClientFacingRespiratoryRateTimeseries
object
6 properties 3 required
Energy
object
2 properties 2 required
ClientFacingWorkout
object
29 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-summary-api-openapi.yml Raw ↑

Other APIs Vital publishes across the network.

Vital Management API
AE Profile APIs.io
Vital Aggregate API
AE Profile APIs.io
Vital compendium API
AE Profile APIs.io
Vital insurance API
AE Profile APIs.io
Vital introspect API
AE Profile APIs.io
Vital lab_account API
AE Profile APIs.io
Vital lab_report API
AE Profile APIs.io
Vital lab_tests API
AE Profile APIs.io
Vital link API
AE Profile APIs.io
Vital order API
AE Profile APIs.io
Vital order_transaction API
AE Profile APIs.io
Vital orders API
AE Profile APIs.io
#Summary
← Back to V APIs
API Details
ID
vital-io:vital-io-summary-api
Base URL
https://api.us.junction.com
Docs
https://docs.junction.com/api-details/junction-api
Provider
Vital
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
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.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

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.