Skip to main content

​
Overview

The VitaRelay API is a headless interface to the VitaRelay healthcare commerce platform. Vita Clinics use it to run the full patient → intake → order → fulfillment loop from their own front end, and connected organizations use it to read their orders, patients, prescriptions, and catalog.

​
Base URL

All requests must be made over HTTPS, and every request is authenticated with an API key sent as a bearer token:
There is no separate sandbox host. The same base URL serves both live and test traffic — the key you send decides which. See Sandbox.

​
What you can do

Write endpoints (POST /patients, POST /intakes, POST /orders) are available to Vita Clinics only. The organization that owns the key must be an active Vita Clinic, and the key must carry the matching :write scope.
All resource identifiers are UUIDs. The only exception is the sandbox, which returns synthetic identifiers such as sandbox_pat_….

​
Quick example

​
Where to go next

Quickstart

Run the full patient → intake → order loop against a test key in minutes.

Authentication

Bearer keys, scopes, and what a 401 or 403 looks like.

API Keys

How VitaRelay issues your key, what it can do, and how to rotate it.

Sandbox

Isolated testing with vr_test_ keys and a simulated order lifecycle.

REST API

Endpoint-by-endpoint reference with request and response shapes.

Webhooks

Signed order and intake events delivered to your endpoint.