Skip to navigation

Quickstart

Make your first Vitable API call and embed the Employee Dashboard in under 5 minutes.

This quickstart confirms that your backend can reach Vitable. The integration guides that follow cover employer onboarding, employee enrollment, and ongoing administration.

Before You Begin

  • Request an API key from the Vitable team.
  • Store it in a server-side environment variable named VITABLE_API_KEY.
  • Review Authentication before using the key.

1. List Employers

Call the employers endpoint to verify your credentials and base URL:

curl https://api.vitablehealth.com/v1/employers \
--header "Authorization: Bearer $VITABLE_API_KEY" \
--header "Content-Type: application/json"
import os
import requests
response = requests.get(
"https://api.vitablehealth.com/v1/employers",
headers={"Authorization": f"Bearer {os.environ['VITABLE_API_KEY']}"},
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.vitablehealth.com/v1/employers", {
headers: { Authorization: `Bearer ${process.env.VITABLE_API_KEY}` },
})
if (!response.ok) {
throw new Error(`Vitable request failed: ${response.status}`)
}
console.log(await response.json())

A 200 OK response confirms that the API key and base URL are valid. An empty list is valid when your organization has not onboarded an employer yet.

2. Choose Your Next Step

GoalContinue with
Onboard your first employer and submit its censusEmployer Onboarding
Add enrollment after employers and employees existEmployee Enrollment
Maintain rosters and process payroll changesBenefits Administration
Embed a ready-made employee or employer interfaceSet Up Vitable Drops
Inspect endpoint schemas and examplesAPI Reference

Start with Employer Onboarding for a new integration. The guides are ordered to match the production lifecycle.