API reference
All endpoints
Everything an API key can do, grouped by topic. Click any line for its fields, a ready-to-copy example and a sample answer.
All paths start with /api/v1 on this site. New here? Read the Quickstart first.
Patients
Find, read, register and update patients. Search is forgiving: any word order, common spelling variants, any part of the phone number, or just the patient number.
Appointments & queue
Doctors, their weekly timings, appointments and the live OPD queue. Everything you need for website booking or a front-desk bot.
- GET
/usersList doctors - GET
/schedulesDoctors' timings and leave - GET
/appointmentsList appointments - GET
/appointments/{id}Get an appointment - GET
/patients/{id}/appointmentsA patient's appointments - GET
/queueOPD queue - POST
/appointmentsBook an appointment - PUT
/appointments/{id}Reschedule an appointment - PATCH
/appointments/{id}/statusCheck in, cancel or change status - POST
/appointments/walk-inAdd a walk-in
Clinical records
Read-only access to a patient's medical record. Needs the records:read scope, which only doctors and clinic admins can grant. Handle this data with care: it's confidential health information.
Billing
Invoices, payments and daily collections, for accounting software, dashboards or reminders about dues.
Pharmacy stock
Read the pharmacy's items, stock levels and alerts. Useful for reorder sheets or a supplier portal.
Reports
Practice numbers for dashboards and daily summaries. Doctors' keys see their own numbers.
Account & clinic
Work with any valid key, whatever its scopes. Call /auth/me first to check the key works and see who it belongs to.
Not listed? Not available to keys.