API Documentation

Use the Avon Health API to create, access, update, and delete patient data, messages, visit notes, forms, insurance claims, and more.

Getting started

Following industry best practices, Avon's APIs are organized around REST. This means our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Along with our APIs, we also offer a no-code platform, where you can write as little or as much code as you want to create your desired EMR and patient engagement platform.

Get your API credentials

Everything you need to start calling the Avon APIs is available directly in the EMR. Log in to your Avon account and go to Settings → API Keys. There you'll find:

  • client_id and client_secret: used to generate an access token
  • base_subdomain: the subdomain for your base URL (see below)
  • account: your account ID, passed in the account header
  • A sample admin_id, provider_id, and support_id: user IDs you can use to make requests as each user type
  • A sample jwt: ready to pass in the x-jwt header

See Authentication for how these are used together.

Try it in Postman

We've created a pre-configured public Postman collection so you can start making requests right away. From Settings → API Keys, download your unique Postman environment file, which is pre-filled with the credentials above, and import it alongside the collection.

BASE URL

https://{{base_subdomain}}.avonhealth.com/v2/

Getting access

If you'd like to get access to our no-code/low-code platform or our APIs, please email hello@avonhealth.com or book a time to chat here.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Resources

Patients

Learn about the patient model and how to create, retrieve, update, delete, and list patients.