Properties

Home

Wearables

Lab Testing

Core

Data Access

Horizon AI

Org Management

x-vital-api-key

Vital

API Reference

Event Catalog

Changelog

Get API Keys

GitHub

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

historical.data.menstrual_cycle.created

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

Getting Support

Dashboard

Providers

Deprecations

Authentication

Data Flow

Rate Limiting

Regions

Introduction

Event Structure

Debugging

Overview

ETL Pipelines

Google Cloud Pub/Sub

RabbitMQ

Azure Event Hubs

Introduction to Link

Link Flow

Launching Link

Provider Types

Link Errors

Building a Custom Widget

Bring Your Own OAuth

Sharing Credentials

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

Abbott LibreView

Apple HealthKit

Android Health Connect

Dexcom (OAuth based)

Dexcom (G6 and older)

Fitbit

Garmin

Google Fit

Omron

Polar

Whoop

Testing Modalities

Order and Follow-up Physician

Insurance Ordering

Testing in Sandbox

Ordering

Lab Test Lifecycle

Order Requirements

Scheduled Orders

Cancelling an Order

Creating a Lab Test

Ordering a Registrable Testkit

Ask on Order Entry (AOE)

Partial Result Notifications

Result Formats

Critical Results

Follow ups

Phlebotomy Service Tiers

Order and Appointment Lifecycle

Webhooks

Communications

Patient Service Centers and Appointments

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 User Demographics

Get User Demographcis

Create Insurance

Get Latest Insurance

Create Sign-In Token

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

Complete Password Provider MFA

Create Order

Get Orders

Get Order

Cancel Order

Get Requisition Form PDF

Creates an order for an unregistered testkit

Create Unregistered Testkit Order

Register Testkit Order

This endpoint returns the printed labels for the order.

Get Labels PDF

Simulate Order

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

Information returned:
* Whether a given zip code is served by our Phlebotomy network.
* List of Lab locations in the area.

Get Area Info

Get Psc Info

Get Order Psc 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

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

PSC Appointment Availability

Book PSC Appointment

Reschedule PSC Appointment

Cancel PSC Appointment

PSC Appointment Cancellation Reasons

Get PSC 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

Get Markers for Order Set

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.

Lab Tests

Provider

Summaries

Activity Timeseries

Vitals Timeseries

Body Timeseries

Diary Timeseries

Nutrition Timeseries

Wellness Timeseries

historical.data.menstrual_cycle.created

Properties

Lab Tests

Provider

Summaries

Activity Timeseries

Vitals Timeseries

Body Timeseries

Diary Timeseries

Nutrition Timeseries

Wellness Timeseries

​Properties

Properties