Getting started

This guide will walk you through the process of getting started with OnCall Health's API.

Receiving access to OnCall Health's API

Currently, OnCall Health's API is only available to active customers.

Please contact your OnCall Health Customer Success Representative to learn whether you are eligible. If so, they will help you create an API key.

How data access via the API works

Each API key is attached to a specific user in OnCall Health. During the setup process, you'll need to let your Customer Success Manager know which user should have access to your organization's data through the API.

Once access is granted, that user can use the API to perform CRUD (Create, Read, Update, Destroy) actions on records (appointments, providers, roster contacts, form assignments, etc) associated with divisions they are a member of.

For this reason, we typically limit your API-enabled user's membership to test divisions by default. When they're ready for production-level access, a Customer Success Manager will grant it.

Ready to start building?

Visit our API Reference to learn more about the endpoints and data accessible via OnCall Health's API. You'll also find instructions for troubleshooting and handling errors.

Alternatively, keep reading through these guides for step-by-step instructions on building various types of integrations with OnCall Health's API.