Get Results Metadata

Wearables

Lab Testing

API Reference

Changelog

x-vital-api-key

Vital

Home

Get API Keys

GitHub

Here you'll find guides, resources, and references to build using Vital's APIs and SDKs.

Welcome

Welcome to our Docs

A quick introduction to building with Vital

Quickstart

Environments

Libraries

Privacy

Authentication

Data Flow

Rate Limiting

Errors

Regions

Introduction

Debugging

Introduction to Link

Link Flow

Launching link

Customization

Supported providers

Resources

Using demo users to build and test your Vital integration

Test data

Dexcom

Freestyle Libre

Garmin

MyFitnessPal (Beta)

Android

Flutter

React Native

Testing Modalities

Lab Test Lifecycle

Ordering a Test

Tracking Progress

Cancelling an Order

Result Formats

Get User

Refresh User Data

Deregister a Provider

List of Providers

Generate a link token

Create Code

Link OAuth provider

Link Password provider

Link Email provider

Link Demo provider

Summary

Stream

Blood Oxygen

Blood Pressure

Caffeine

Cholesterol

Glucose

Heartrate

Heartrate variability

Hypnogram

Mindfulness Minutes

Respiratory Rate

Steps

Water

Get Available Tests

Get Results

Get Results PDF

APIKeyRole

ActivityV2InDB

AddressPurpose

AddressType

AnswerAttachment

AnswerBoolean

AnswerDecimal

AnswerInteger

AnswerString

ApiKeyInDB

Attachment

AuthType

BeginLinkTokenRequest

BiologicalSex

BodyV2InDB

Daily Activity

ClientBodyResponse

ClientFacingApiKey

ClientFacingBloodOxygenTimeseries

ClientFacingBloodPressureTimeseries

ClientFacingBody

ClientFacingCaffeineTimeseries

ClientFacingCholesterolTimeseries

ClientFacingGlucoseTimeseries

ClientFacingHRVTimeseries

ClientFacingHeartRateTimeseries

ClientFacingHypnogramTimeseries

ClientFacingIgeTimeseries

ClientFacingIggTimeseries

ClientFacingLabTest

ClientFacingMealResponse

ClientFacingMindfulnessMinutesTimeseries

ClientFacingOrderEvent

ClientFacingProfile

ClientFacingRespiratoryRateTimeseries

Schema for a Shipment in the client facing API.

To be used as part of a ClientFacingTestkitOrder.

ClientFacingShipment

Sleep Data

Sleep stream data

Oura

Provider

ClientFacingSport

ClientFacingStepsTimeseries

ClientFacingStream

ClientFacingTeam

ClientFacingTestKitOrderDetails

Schema for a testkit order in the client facing API.

To be used as part of a ClientFacingOrder.

ClientFacingTestkitOrder

ClientFacingTimeseries

User

ClientFacingUserKey

ClientFacingWalkInOrderDetails

Schema for a walk-in test order in the client facing API.

To be used as part of a ClientFacingOrder.

ClientFacingWalkInTestOrder

ClientFacingWaterTimeseries

Workout Data

Body Composition Data

ClientWorkoutResponse

ConnectedSourceClientFacing

ConnectedSourceClientFacingRedacted

ConnectionStatus

Consent

ConsentType

ContactPoint

CreateApiKeyBody

CreateOrderRequestCompatible

DataStage

DemoConnectionCreationPayload

DemoConnectionStatus

DeviceV2InDB

EmailAuthLink

EmailProviderAuthLink

EmailProviders

Energy

Fats

GetOrdersResponse

HTTPValidationError

HumanName

IndividualProviderData

LabClientFacing

LabInDB

LabResultsMetadata

LabResultsRaw

LabTestInDB

LabTestMethod

The type of sample used to perform a lab test.

LabTestSampleType

LinkId

LinkTokenBase

LinkTokenExchange

LinkTokenExchangeResponse

Macros

ManualActivityCreation

ManualActivityCreationPayload

ManualBloodPressureCreation

ManualBloodPressureCreationPayload

ManualBodyCreationIntermediate

ManualBodyCreationPayload

ManualConnectionData

ManualProfileCreation

ManualProfileCreationPayload

ManualProviders

ManualSleepCreation

ManualSleepCreationPayload

ManualSleepStageCreation

ManualTimeseriesCreationPayload

ManualWorkoutCreation

ManualWorkoutCreationPayload

MarkerClientFacing

MarkerInDB

Dinner

MealInDBBase[ClientFacingSource]

MetricsResult

Micros

OAuthProviders

OrderClientName

OrderStatus

OrderV2Status

OrderV2TopLevelStatus

OrdersResponse

PaginatedUsersResponse

PasswordAuthLink

PasswordProviders

PatientAddress

PatientAddressCompatible

PatientDetails

PatientDetailsCompatible

PersonAddress