API scopes

Each operation requires one scope. A practice admin grants scopes in Settings → API Keys. The public reference marks the scope on each operation as x-required-scope.

Standard scopes

• clients:read
• clients:write
• patients:read
• patients:write
• appointments:read
• appointments:write
• invoices:read
• imaging:read
• imaging:write
• inventory:read
• documents:read
• waitlist:read
• reminders:read
• tasks:read

Opt-in scopes

These are grantable, and they are not included unless an admin selects them. They cover clinical records, messages, inventory changes, and invoice finalisation.

• clinical:read
• soap:read
• soap:write
• consultations:read
• vitals:read
• vitals:write
• labs:read
• labs:write
• diagnoses:read
• diagnoses:write
• problems:read
• problems:write
• procedures:read
• procedures:write
• anaesthesia:read
• anaesthesia:write
• consent:read
• consent:write
• treatments:read
• treatments:write
• home_sheets:read
• weights:read
• allergies:read
• allergies:write
• invoice_lines:read
• payments:read
• estimates:read
• estimates:write
• estimates:issue
• reminders:write
• pet_plans:read
• procurement:read
• procurement:write
• procurement:commit
• cd:read
• documents:content
• communications:read
• vaccinations:write
• inventory:write
• inventory:move
• tasks:write
• invoices:finalise
• messages:send

Not grantable

These scopes are internal. Settings cannot put them on a partner key: vm_ingest:write, agent:run, *.