Cliniko is practice management software for allied health clinics - physiotherapy, chiropractic, massage, podiatry and psychology. Manage patients, appointments, treatment notes, invoices and contacts, look up available booking times, and react to new or updated records with polling triggers.
Changelog
1 version
v1.0.0
Latest
- Initial release.
Authentication
| Type | Details |
|---|---|
| API Key |
API Key (password)
In Cliniko go to My Info → Manage API keys → Create API key, then paste the key here.
|
Triggers
7
Cancelled Appointment
Triggers when an individual appointment is cancelled. Cancelled appointments are normally hidden from the API; this trigger asks for them explicitly and polls the "cancelled at" timestamp. The first run only records a baseline.
New Appointment
Triggers when a new individual appointment is booked. Optionally narrow it to one practitioner or business. The first run only records a baseline and emits nothing.
New Booking
Triggers when a new booking appears in the calendar. Bookings cover individual and group appointments as well as unavailable blocks, which makes this the trigger to use for patient-made online bookings. The first run only records a baseline.
New Invoice
Triggers when a new invoice is created. The first run only records a baseline and emits nothing.
New Patient
Triggers when a new patient is created in Cliniko. Cliniko has no webhooks, so this polls the patient list on the account's tick interval and emits patients created since the previous run. The first run only records a baseline and emits nothing.
Updated Appointment
Triggers when an individual appointment is changed - rescheduled, annotated or marked as arrived. Polling is based on the "updated at" timestamp, so a newly booked appointment fires this trigger too. The first run only records a baseline.
Updated Patient
Triggers when a patient record is changed. Polling is based on the patient's "updated at" timestamp, so a newly created patient fires this trigger too. The first run only records a baseline and emits nothing.
Actions
23
Cancel Appointment
Cancels an individual appointment, keeping it on record with a cancellation reason. This is not a deletion - the appointment stays in Cliniko and reporting. Returns an empty object.
Create Appointment
Books a new individual (one-on-one) appointment. End time is derived from the appointment type duration unless you set it explicitly.
Create Contact
Creates a contact - a referring doctor, a third-party payer or any other non-patient contact. Cliniko requires a First Name or a Last Name even for a company contact.
Create Medical Alert
Adds a medical alert to a patient. Alerts are shown prominently on the patient record in Cliniko.
Archive Patient
Archives a patient. Archived patients are hidden from Cliniko and excluded from searches, but nothing is destroyed - use Unarchive Patient to bring them back. Returns an empty object.
Create Treatment Note
Creates a treatment note for a patient. Cliniko stores note bodies as a structured sections object, so Content takes JSON in the shape
{"sections":[{"name":"Subjective","questions":[{"name":"Complaint","type":"text","answer":"..."}]}]}. Copy the shape from an existing note (Find Treatment Notes) or from the treatment note template.
Find Appointments
Searches individual (one-on-one) appointments by date range, patient, practitioner or business. Returns up to 100 appointments (one page at the maximum page size).
Find Available Times
Finds the bookable appointment start times for a practitioner at a business, for a given appointment type, within a date window. The business, practitioner and appointment type must all be enabled for online bookings in Cliniko - otherwise the endpoint answers 404. Cliniko allows a window of at most 7 days and will not look into the past.
Find Contacts
Searches contacts (referring doctors, third-party payers and other non-patient contacts) by name, company or email. Name, company and email filters are "contains" matches. Returns up to 100 contacts (one page at the maximum page size).
Find Invoices
Searches invoices by patient, practitioner, business, status or issue date. Returns up to 100 invoices (one page at the maximum page size).
Find Patients
Searches patients by name, email or date of birth. Name and email filters are "contains" matches. Returns up to 100 patients (one page at the maximum page size).
Find Treatment Notes
Searches treatment notes by patient, practitioner or draft status. Returns up to 100 treatment notes (one page at the maximum page size). Note that the API key inherits the permissions of its Cliniko user - a user without clinical access gets a 403 here.
Get Next Available Time
Returns the single next bookable appointment start time for a practitioner at a business, for a given appointment type. The business, practitioner and appointment type must all be enabled for online bookings in Cliniko - otherwise the endpoint answers 404. Cliniko allows a window of at most 7 days and will not look into the past.
List Appointment Types
Lists the appointment types configured in the Cliniko account. Returns up to 100 appointment types (one page at the maximum page size).
List Businesses
Lists the businesses (clinic locations) in the Cliniko account. Returns up to 100 businesses (one page at the maximum page size).
List Practitioners
Lists the practitioners in the Cliniko account. Returns up to 100 practitioners (one page at the maximum page size).
Make API Call
Performs an arbitrary authorized call against the Cliniko API. The path is resolved against the base URL derived from your API key's shard, so a path such as
/patients is enough.
Update Appointment
Reschedules or edits an existing individual appointment. Only the fields you fill in are sent. To cancel an appointment use Cancel Appointment instead. Returns an empty object.
Update Patient
Updates an existing patient. Only the fields you fill in are sent - everything else is left untouched. Returns an empty object.