Quickstart

Clarion API home page

Support

Quickstart

Documentation

API Reference

Quickstart

Health

GET
Get Health

Assistants

GET
Get Assistant
GET
List Assistant
POST
Create Assistant
PATCH
Update Assistant
DEL
Delete Assistant

Calls

GET
Get call
GET
List Calls
POST
Create Call
DEL
Delete Call Record

Tools (Beta)

GET
Get Tool
GET
List Tools
POST
Create Tool
PATCH
Update Tool
DEL
Delete Tool

Phone Numbers

GET
Get Phone Number
GET
List Phone Numbers

Referral Management

GET
List Referrals
POST
Create Referral

Quickstart

Get started with the Clarion API in minutes

Setup your environment

This section will walk you through configuring your API key and sending your first requests.

Set up your API key

The base URL for the API is: https://api.clarionhealth.com/v1. You can test out your connection by sending the following request:

GET https://api.clarionhealth.com/v1/health

You should see a response that looks like: [200] {"message": "healthy"}

During your onboarding process, you should have received your developer API key via secure sharing. It should look something like this: prod_api_5394gcf5-77ec-4c1d-87b7-dddc75909462

If you do not have an API key or need help accessing it, please reach out to support@clarionhealth.com

Most requests require you to set your authentication token in the Authorization header. You can do this by adding an Authorization header and setting the value to Bearer <your_auth_token>.

Here is an example of a request that will list all of the recent call records for your organization:

GET https://api.clarionhealth.com/v1/call

Authorization: Bearer prod_api_5394gcf5-77ec-4c1d-87b7-dddc75909462

Get Health

On this page

Setup your environment
Set up your API key

Quickstart

Health

Assistants

Calls

Tools (Beta)

Phone Numbers

Referral Management

​Setup your environment

​Set up your API key

Setup your environment

Set up your API key