Libraries

Wearables

Lab Testing

API Reference

Event Catalog

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

Privacy

Authentication

Data Flow

Rate Limiting

Errors

Regions

Introduction

Event Structure

Debugging

Introduction to Link

Link Flow

Launching link

Customization

Supported providers

Resources

Time zone awareness

Using demo users to build and test your Vital integration

Test data

Dexcom

Fitbit

Freestyle Libre

Garmin

Google Fit

MyFitnessPal (Beta)

Android

Flutter

React Native

Testing Modalities

Lab Test Lifecycle

Order Requirements

Tracking Progress

Cancelling an Order

Result Formats

Follow ups

POST Create a Vital user given a client_user_id and returns the user_id.

Create User

Get User

Patch User

Delete User

Get Teams Users

Get Connected Providers

Trigger a manual refresh for a specific user

Refresh User Data

Deregister a Provider

List of Providers

Endpoint to generate a user link token, to be used throughout the vital
link process. The vital link token is a one time use token, that
expires after 10 minutes. If you would like vital-link widget to launch
with a specific provider, pass in a provider in the body. If you would
like to redirect to a custom url after successful or error connection,
pass in your own custom redirect_url parameter.

Generate a link token

Generate a token to invite a user of Vital mobile app to your team

Create Code

This endpoint generates an OAuth link for oauth provider

Link OAuth provider

This connects auth providers that are password based.

Link Password provider

This connects auth providers that are email based.

Link Email provider

POST Connect the given Vital user to a demo provider.

Link Demo provider

Summary

Stream

Blood Oxygen

Blood Pressure

Caffeine

Cholesterol

Glucose

Heartrate

Heartrate variability

Hypnogram

Mindfulness Minutes

Respiratory Rate

Steps

Water

Create Order

Get Orders

Get Order

Cancel Order

GET information about an area with respect to lab-testing.

Information returned:
* Whether a given zip code is served by our Phlebotomy network.

Get Area Info

Return the available time slots to book an appointment with a phlebotomist
for the given address and order.

Get Order Appointment Availability

Book Phlebotomy Appointment

Reschedule a previously booked at-home phlebotomy appointment.

Reschedule Phlebotomy Appointment

Cancel a previously booked at-home phlebotomy appointment.

Cancel Phlebotomy Appointment

Get the list of reasons for cancelling an at-home phlebotomy appointment.

Get Phlebotomy Appointment Cancellation Reasons

Get the appointment associated with an order.

Get Phlebotomy Appointment

GET all the lab tests the team has access to.

Get Available Tests

Return both metadata and raw json test data

Get Results

This endpoint returns the lab results for the order.

Get Results PDF

Return metadata related to order results, such as lab metadata,
provider and sample dates.

Get Results Metadata

labtest.order.created

labtest.order.updated

provider.connection.created

Provider Connection failed to be established, or has failed due to user credential changes.

provider.connection.error

Activity summary has been created for a new calendar day

daily.data.activity.created

The activity summary of a calendar day has been updated

daily.data.activity.updated

daily.data.body.created

daily.data.body.updated

daily.data.profile.created

daily.data.sleep.created

An existing sleep session has been updated

daily.data.sleep.updated

daily.data.workouts.created

An existing workout session has been updated

daily.data.workouts.updated

A workout stream has been created, and can be accessed via the /v2/timeseries/workouts/&lcub;workout_id&rcub;/stream endpoint.

daily.data.workout_stream.created

Historical pull of activity data has completed and you can now pull data for this resource.

historical.data.activity.created

Historical pull of body data has completed and you can now pull data for this resource.

historical.data.body.created

Historical pull of profile data has completed and you can now pull data for this resource.

historical.data.profile.created

Historical pull of sleep data has completed and you can now pull data for this resource.

historical.data.sleep.created

Historical pull of workouts data has completed and you can now pull data for this resource.

historical.data.workouts.created

New calories_active samples have been created

daily.data.calories_active.created

Existing calories_active samples have been updated

daily.data.calories_active.updated

New calories_basal samples have been created

daily.data.calories_basal.created

Existing calories_basal samples have been updated

daily.data.calories_basal.updated

daily.data.distance.created

Existing distance samples have been updated

daily.data.distance.updated

New floors_climbed samples have been created

daily.data.floors_climbed.created

Existing floors_climbed samples have been updated

daily.data.floors_climbed.updated

daily.data.steps.created

daily.data.steps.updated

daily.data.vo2_max.created

Existing vo2_max samples have been updated

daily.data.vo2_max.updated

Historical pull of calories_active data has completed and you can now pull data for this resource.

historical.data.calories_active.created

Historical pull of calories_basal data has completed and you can now pull data for this resource.

historical.data.calories_basal.created

Historical pull of distance data has completed and you can now pull data for this resource.

historical.data.distance.created

Historical pull of floors_climbed data has completed and you can now pull data for this resource.

historical.data.floors_climbed.created

Historical pull of steps data has completed and you can now pull data for this resource.

historical.data.steps.created

Historical pull of vo2_max data has completed and you can now pull data for this resource.


vital-python	Python library for calling Vital API on your backend
vital-link	React Library for initializing link
vital-node	Vital Node Client
vital-ios	Vital iOS Client
vital-android	Vital Android Client
vital-flutter	Vital Flutter Client
vital-react-native	Vital React Native Client
Java	Soon to be added
Go	Soon to be added

Home

API

Webhooks

Libraries

Supported Libraries

Home

API

Webhooks

​Supported Libraries

Supported Libraries