Quickstart

You need an API key (Authentication) and the practice’s host, https://{clinic}.{region}.practicehub.io — the region host is the one in the practice’s login URL — neptune (London), mercury (Frankfurt), vulcan (Ohio), jupiter (Singapore) or apollo (Sydney). Replace your-clinic.your-region and $KEY below.

Discover the model

curl https://your-clinic.your-region.practicehub.io/v3/api/schema/appointments \
  -H "Authorization: Bearer $KEY"

The response lists the resource’s attributes, which are filterable and sortable, the write operations it supports and the input each accepts.

Find the reference data

curl "https://your-clinic.your-region.practicehub.io/v3/api/locations" -H "Authorization: Bearer $KEY"
curl "https://your-clinic.your-region.practicehub.io/v3/api/appointment_types" -H "Authorization: Bearer $KEY"
curl "https://your-clinic.your-region.practicehub.io/v3/api/practitioners?active=eq:1" -H "Authorization: Bearer $KEY"

Create the patient

curl -X POST https://your-clinic.your-region.practicehub.io/v3/api/patients \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{
    "first_name": "Ada", "last_name": "Lovelace", "email": "ada@example.com",
    "numbers": [{ "number": "07700900123", "country_code": "44", "iso2": "GB", "type": "mobile" }],
    "metadata": { "crm_id": "hs-778" }
  }'

The response is the created record under data, including its id and your metadata.

Find a free slot

curl "https://your-clinic.your-region.practicehub.io/v3/api/availability?location_id=81&appointment_type_id=1&from=2026-09-01" \
  -H "Authorization: Bearer $KEY"

location_id and appointment_type_id are ids from the previous step — yours will differ. Free, bookable slots for the coming week in the clinic’s timezone — each with the practitioner_id, starts_at and ends_at to book. See Booking for the patient vs staff view and the parameters.

Book the appointment

curl -X POST https://your-clinic.your-region.practicehub.io/v3/api/appointments \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{
    "patient_id": 340, "location_id": 81, "appointment_type_id": 1, "practitioner_id": 109,
    "starts_at": "2026-09-01T09:00:00", "ends_at": "2026-09-01T09:30:00", "note": "Booked from the website"
  }'

Times are in the clinic’s timezone. The booking is validated exactly as in the PracticeHub calendar (active patient, location, practitioner, resource) — and, like a staff click, it does not re-check the diary, so book a slot /availability returned — and confirmation messaging is triggered as normal.

Find it again later

curl -g "https://your-clinic.your-region.practicehub.io/v3/api/patients?metadata[crm_id]=eq:hs-778" \
  -H "Authorization: Bearer $KEY"

Prefer to let an AI do this? The MCP server exposes the same model to Claude and ChatGPT (read-only during the limited rollout).

Getting started

Concepts

Working with the API

Ship it

Resource guides

Importing your data