This is the official API for Cliniko. Cliniko is a practice management system for healthcare practitioners.
The Cliniko API is based on REST principles. This means you can use any HTTP client and any programming language to interact with the API.
JSON will be returned in all responses from the API.
{ "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices" } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "patient_case": { "links": { "self": "https://api.au1.cliniko.com/v1/patient_cases/1" } }, "patient_forms": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/patient_forms" } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" }
curl -i -X GET \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/attendees?order=asc&page=0&per_page=1&q%5B%5D=string&sort=created_at%3Adesc'
{ "attendees": [ { "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { … } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { … } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { … } }, "patient_case": { "links": { … } }, "patient_forms": { "links": { … } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" } ], "total_entries": 1, "links": { "self": "https://api.au1.cliniko.com/v1/attendees?page=2", "previous": "https://api.au1.cliniko.com/v1/attendees?page=1", "next": "https://api.au1.cliniko.com/v1/attendees?page=3" } }
curl -i -X POST \ -u <username>:<password> \ https://api.au1.cliniko.com/v1/attendees \ -H 'Content-Type: application/json' \ -d '{ "booking_id": "1", "arrived": true, "notes": "string", "patient_id": "1", "patient_case_id": "1" }'
{ "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices" } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "patient_case": { "links": { "self": "https://api.au1.cliniko.com/v1/patient_cases/1" } }, "patient_forms": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/patient_forms" } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" }
curl -i -X GET \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/attendees/{id}?q%5B%5D=string'
{ "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices" } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "patient_case": { "links": { "self": "https://api.au1.cliniko.com/v1/patient_cases/1" } }, "patient_forms": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/patient_forms" } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" }
curl -i -X PATCH \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/attendees/{id}' \ -H 'Content-Type: application/json' \ -d '{ "arrived": true, "notes": "string", "patient_case_id": "1" }'
{ "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices" } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "patient_case": { "links": { "self": "https://api.au1.cliniko.com/v1/patient_cases/1" } }, "patient_forms": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1/patient_forms" } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" }
Only attendees of group appointments can be cancelled via this endpoint. Cancelling an individual appointment should be done via the cancel endpoint for individual appointments
| Enum Value | Description |
|---|---|
| 10 | Feeling better |
| 20 | Condition worse |
| 30 | Sick |
| 40 | Away |
| 50 | Other |
| 60 | Work |
curl -i -X PATCH \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/attendees/{id}/cancel' \ -H 'Content-Type: application/json' \ -d '{ "cancellation_note": "string", "cancellation_reason": 10, "apply_to_repeats": true }'
curl -i -X GET \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/group_appointments/{group_appointment_id}/attendees?order=asc&page=0&per_page=1&q%5B%5D=string&sort=created_at%3Adesc'
{ "attendees": [ { "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { … } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { … } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { … } }, "patient_case": { "links": { … } }, "patient_forms": { "links": { … } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" } ], "total_entries": 1, "links": { "self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=2", "previous": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=1", "next": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=3" } }
curl -i -X GET \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/individual_appointments/{individual_appointment_id}/attendees?order=asc&page=0&per_page=1&q%5B%5D=string&sort=created_at%3Adesc'
{ "attendees": [ { "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { … } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { … } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { … } }, "patient_case": { "links": { … } }, "patient_forms": { "links": { … } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" } ], "total_entries": 1, "links": { "self": "https://api.au1.cliniko.com/v1/individual_appointments/1/attendees?page=2", "previous": "https://api.au1.cliniko.com/v1/individual_appointments/1/attendees?page=1", "next": "https://api.au1.cliniko.com/v1/individual_appointments/1/attendees?page=3" } }
curl -i -X GET \ -u <username>:<password> \ 'https://api.au1.cliniko.com/v1/patient_cases/{patient_case_id}/attendees?order=asc&page=0&per_page=1&q%5B%5D=string&sort=created_at%3Adesc'
{ "attendees": [ { "archived_at": "2019-08-24T14:15:22Z", "arrived": true, "booking": { "links": { … } }, "booking_ip_address": "10.0.0.43", "cancellation_note": "string", "cancellation_reason": 0, "cancellation_reason_description": "Feeling Better", "cancellation_url": "http://example.com", "cancelled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "email_reminder_sent": true, "id": "string", "invoice_status": 10, "invoices": { "links": { … } }, "links": { "self": "https://api.au1.cliniko.com/v1/attendees/1" }, "notes": "string", "online_booking_policy_accepted": true, "patient": { "links": { … } }, "patient_case": { "links": { … } }, "patient_forms": { "links": { … } }, "sent_email_reminders_count": 0, "sent_sms_reminders_count": 0, "sms_reminder_sent": true, "telehealth_url": "http://example.com", "treatment_note_status": 10, "updated_at": "2019-08-24T14:15:22Z" } ], "total_entries": 1, "links": { "self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees?page=2", "previous": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees?page=1", "next": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees?page=3" } }
Cliniko users can configure how available times are displayed in our online bookings module.
The API endpoints that retrieve available times will respect these settings. The settings are:
Day parts are morning (before Midday), afternoon (Midday to 5pm) and evening (5pm onwards).
Possible settings are: 1, 2, 3, 4, 5 or unlimited.
This is the minimum amount of time from now that a available time will be shown.
Possible settings are: Now, 1 Hour, 2 Hours, 4 Hours, Tomorrow or 2 Days.
This limits how far in the future available times are offered.
Possible settings are: 28 days, 84 days, 182 days or 365 days
Setting to choose which businesses can be displayed in our online bookings module.
The API will not return available times for businesses not enabled for online bookings.
Setting to choose which appointment types can be displayed in our online bookings module.
The API will not return available times for appointment types not enabled for online bookings.
Setting to choose which practitioners can be displayed in our online bookings module.
The API will not return available times for practitioners not enabled for online bookings.
Patients are the people that book in for appointments. There isn't much in Cliniko that doesn't revolve around patients.
When you're working with patient information, make sure you abide by the relevant regulations for security and privacy.
A couple of fields in the patient record deserve special consideration:
accepted_privacy_policy stores the patient's consent to the business's own privacy policy. Values can be null (no response), true (accepted) or false (rejected). Please consider how this may affect you storing information on this patient.
time_zone will contain a valid IANA time zone identifier if the patient's time zone has been set, or null if it hasn't. It can be set via the API, in which case it accepts IANA time zone identifiers.
HTML is supported in answers to paragraph questions. We sanitize these answers to ensure the HTML is safe and our editor can support the formatting.
Currently, the following tags are supported: p, div, br, ul, ol, li, blockquote, h1, h2, b, i, u, and a.
The angle bracket characters (<, and >) should be sent as html encodings (ex: < should be sent as <).
Content inside unescaped angle brackets could be indentified as unsupported HTML and will be stripped.
Notes taken about a patient visit.
HTML is supported in answers to paragraph questions. We sanitize these answers to ensure the HTML is safe and our editor can support the formatting.
Currently, the following tags are supported: p, div, br, ul, ol, li, blockquote, h1, h2, b, i, u, and a.
The angle bracket characters (<, and >) should be sent as html encodings (ex: < should be sent as <).
Content inside unescaped angle brackets could be indentified as unsupported HTML and will be stripped.
Templates that are the starting point for treatment notes.
HTML is supported in answers to paragraph questions. We sanitize these answers to ensure the HTML is safe and our editor can support the formatting.
Currently, the following tags are supported: p, div, br, ul, ol, li, blockquote, h1, h2, b, i, u, and a.
The angle bracket characters (<, and >) should be sent as html encodings (ex: < should be sent as <).
Content inside unescaped angle brackets could be indentified as unsupported HTML and will be stripped.