Developers · API

Build on the MyOrbit API.

A REST API and webhook stream for patients, appointments, intake, and prescriptions. Designed for production telemedicine workloads.

Base URL

https://api.myorbithealth.com/v1

The API is versioned in the path. Breaking changes ship under a new version; non-breaking additions ship under the current version.

Authentication

curl https://api.myorbithealth.com/v1/patients \
  -H "Authorization: Bearer $ORBIT_API_KEY"

Bearer-token auth with environment-scoped keys (test / live). Keys are issued from the partner console and rotated on demand.

Rate limits

Default: 600 requests / minute / key, burst up to 1,200. Limits are returned inX-RateLimit-*response headers. Contact us for higher quotas.

Errors

Standard HTTP status codes. Error bodies follow { error: { code, message, details } }. 4xx errors are safe to retry only after correction; 5xx are safe to retry with exponential backoff.

Endpoints

Core resources

POST/v1/patients

Create a patient

Idempotent patient creation. Returns the canonical patient record and any matched duplicates.

curl -X POST https://api.myorbithealth.com/v1/patients \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Ada",
    "last_name": "Lovelace",
    "dob": "1990-12-10",
    "state": "CA"
  }'
POST/v1/appointments

Schedule an appointment

Match a patient with an in-network clinician and create a scheduled visit.

curl -X POST https://api.myorbithealth.com/v1/appointments \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "patient_id": "pat_01H...",
    "specialty": "primary_care",
    "modality": "async"
  }'
GET/v1/prescriptions/:id

Retrieve a prescription

Returns the prescription record, dispense status, and pharmacy routing.

curl https://api.myorbithealth.com/v1/prescriptions/rx_01H... \
  -H "Authorization: Bearer $ORBIT_API_KEY"
POST/v1/webhooks

Register a webhook

Subscribe to platform events. Payloads are signed with HMAC-SHA256.

curl -X POST https://api.myorbithealth.com/v1/webhooks \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/orbit",
    "events": ["appointment.completed", "prescription.dispensed"]
  }'

Get started

Want a sandbox key?

API access is provisioned after a short partner review. Tell us about your use case and we’ll get you a sandbox within a day.

Request access