Wearables

Lab Testing

API Reference

Event Catalog

Changelog

x-vital-api-key

Vital

Home

Get API Keys

GitHub

Debugging

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

Providers

Deprecations

Authentication

Data Flow

Rate Limiting

Regions

Customer Managed Encryption Keys

Introduction

Event Structure

ETL Pipelines

Introduction to Link

Link Flow

Launching link

Provider Types

Link Errors

Building a Custom Widget

Bring Your Own OAuth

Supported providers

Resources

Heart Rate Zones

Timestamps and Time Zones

Data Ingestion Bounds

Data Attributions

Using demo users to build and test your Vital integration

Test data

Installation

Mobile SDK Authentication

Core SDK

Vital Core SDK

Health SDK

Vital Health SDK

Devices SDK

Vital Devices SDK

Apple HealthKit

Android Health Connect

Dexcom

Dexcom (G6 And Older)

Fitbit

Freestyle Libre

Garmin

Google Fit

MyFitnessPal

Polar

Whoop

Testing Modalities

Order and Follow-up Physician

Testing in Sandbox

Lab Test Lifecycle

Order Requirements

Scheduled Orders

Tracking Progress

Cancelling an Order

Creating a Lab Test (Beta)

Ordering a Registrable Testkit

Result Formats

Critical Results

Follow ups

Overview

Phlebotomy Service Tiers

Order and Appointment Lifecycle

Webhooks

Communications

Order Lifecycle

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

Create User

Get User

Get User by Client User ID

Patch User

Delete User

Undo User Deletion

Get Teams Users

Create Sign-In Token

Introspect Resources

Introspect Historical Pulls

List of Providers

Get User Connections

Trigger a manual refresh for a specific user

Refresh User Data

Deregister Connection

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

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

Get Requisition Form PDF

Creates an order for an unregistered testkit

Create Unregistered Testkit Order

Register Testkit Order

Simulate Order

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

Request an at-home phlebotomy appointment.

Request 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

Get Available Biomarkers

Get All Available Labs

Create a Test

Get Markers for Lab Test

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

Search Insurance Payor Information

Search Diagnosis

Summary

Stream

Blood Oxygen

Blood Pressure

Cholesterol

Electrocardiogram Voltage

Glucose

Heart Rate

Heart Rate Variability

Respiratory Rate

Vo2 Max

Body Fat

Body Weight

Calories Active

Calories Basal

Distance

Floors Climbed

Steps

Hypnogram

Mindfulness Minutes

Stress Level

Caffeine

Water

List Teams

Create Team

Get Team

Delete Team

Update Team

List Members

Delete Member

List Invites

Create or Resend Invite

Revoke Invite

Get Org

Update Org

List Team API Keys

Create Team API Key

Delete Team API Keys

Get Team Custom Credentials

Set Team Custom Credentials

Delete Team Custom Credentials

Get Team ETL Pipelines

Set Team ETL Pipelines

Delete Team ETL Pipelines

Get Team Scope Requirements

Set Team Scope Requirements

labtest.order.created

labtest.order.updated

labtest.result.critical

An apppointment has been updated or created

labtest.appointment.update

provider.connection.created

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

provider.connection.error

Home

API

Webhooks & Events

Debugging

Vital Dashboard

Home

API

Webhooks & Events

​Vital Dashboard

Vital Dashboard