Product Services TrainingBook a Call Get Started – Free

Get started Patient access Clinician workflow Backend Network Directory API Reference Changelog

System

Liveness check GET

Patients

List patients GET Create a patient POST Retrieve a patient GET Get patient records GET Delete a patient DELETE Update a patient PUT

Connections

Retrieve a FHIR source GET List FHIR sources GET

Patient sessions

List patient sessions for a patient GET Start a patient session POST Retrieve a patient session GET Retrieve an EHR launch context GET

Webhooks

List webhook endpoints GET Register a webhook endpoint POST Retrieve a webhook endpoint GET Update a webhook endpoint PATCH Delete a webhook endpoint DELETE Rotate the signing secret for a webhook endpoint POST List recent webhook events for an endpoint GET Manually redeliver a webhook event POST

Other

Disconnect a connection DELETE

List patients

List your organization's patients with cursor pagination and optional exact-match filters on patient_id or email.

Need help?

Running into an issue? Get support from our team and we will get back to you.

How is this guide?

Liveness check GET

Unauthenticated probe that returns ok and the current server_time to confirm the API is reachable.

Create a patient POST

Create a patient with your own patient_id plus optional email, name, and metadata. The id is unique within your organization.