Vital home pagelight logodark logo
  • Get API Keys
  • GitHub
  • Get API Keys
Home
Welcome to our Docs
  • Home
  • Wearables
  • Lab Testing
  • API Reference
  • Event Catalog
  • Home
  • Welcome
  • Quickstart
  • Environments
  • Libraries
  • Privacy
  • API
  • Authentication
  • Data Flow
  • Rate Limiting
  • Errors
  • Regions
  • Customer Managed Encryption Keys
  • Webhooks
  • Introduction
  • Event Structure
  • Debugging
Home

Welcome to our Docs

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

Quickstart

The Quickstart walk-through gives you an overview of how to integreate with Vital. By the end of this guide, you’ll have a working app with both backend and frontend.

Providers

Here you can find all the available providers, alongside our roadmap. You can see how each provider behave (pull vs webhook) and the default max amount of days we pull from each. For custom integrations, please contact us.

Environments

This gives you a quick glance about our environments and regions. It also tells you the difference between production and sandbox

Labs and Test Kits

Vital’s lab test API allows digital health companies to carry out at-home lab testing. Companies can use the API to order a variety of tests, using various sampling methods.

​
Popular Topics

Apple HealthKit

Apple HealthKit is one of the biggest providers of fitness and health data. Here you can learn how to integrate it with via our SDKs. We currently support iOS, Flutter and React Native.

Vital Link

Vital Link is what allows your users to connect their wearable devices to Vital. It’s a simple widget that you can add to your app. Learn how to integrate it here.

Fields per Resource per Provider

A provider like Garmin can have multiple resources (e.g. Workouts, Sleep). Each resource, might not have all the fields. Learn which fields are available for each resource here.

Webhooks

Webhooks are the preferred way for Vital to send information to you when something happens. Here you can find the different flows for historical data and daily.

Demo accounts

Our demo accounts allow you to generate fake data for particular providers. This makes the testing process much easier! Learn how to use them here.

Quickstart
websitetwitterlinkedin
Powered by Mintlify