# Cliniko API 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. Version: v1 ## Servers Production ``` https://api.au1.cliniko.com/v1 ``` ## Security ### basicAuth Type: http Scheme: basic ## Download OpenAPI description [Cliniko API](https://docs.api.cliniko.com/_bundle/openapi.yaml) ## Appointment Type ### List appointment types - [GET /appointment_types](https://docs.api.cliniko.com/openapi/appointment-type/listappointmenttypes-get.md) ### Create appointment type - [POST /appointment_types](https://docs.api.cliniko.com/openapi/appointment-type/createappointmenttype-post.md) ### Get appointment type - [GET /appointment_types/{id}](https://docs.api.cliniko.com/openapi/appointment-type/getappointmenttype-get.md) ### Update appointment type - [PATCH /appointment_types/{id}](https://docs.api.cliniko.com/openapi/appointment-type/updateappointmenttype-patch.md) ### Archive appointment type - [POST /appointment_types/{id}/archive](https://docs.api.cliniko.com/openapi/appointment-type/archiveappointmenttype-post.md) ### List appointment types for practitioner - [GET /practitioners/{practitioner_id}/appointment_types](https://docs.api.cliniko.com/openapi/appointment-type/listappointmenttypesforpractitioner-get.md) ### Archive appointment type (deprecated) - [DELETE /appointment_types/{id}](https://docs.api.cliniko.com/openapi/appointment-type/deleteappointmenttype-delete.md) ## Appointment Type Billable Item ### List appointment type billable items - [GET /appointment_type_billable_items](https://docs.api.cliniko.com/openapi/appointment-type-billable-item/listappointmenttypebillableitems-get.md) ### Create appointment type billable item - [POST /appointment_type_billable_items](https://docs.api.cliniko.com/openapi/appointment-type-billable-item/createappointmenttypebillableitem-post.md) ### Get appointment type billable item - [GET /appointment_type_billable_items/{id}](https://docs.api.cliniko.com/openapi/appointment-type-billable-item/getappointmenttypebillableitem-get.md) ### Update appointment type billable item - [PATCH /appointment_type_billable_items/{id}](https://docs.api.cliniko.com/openapi/appointment-type-billable-item/updateappointmenttypebillableitem-patch.md) ### Delete appointment type billable item - [DELETE /appointment_type_billable_items/{id}](https://docs.api.cliniko.com/openapi/appointment-type-billable-item/deleteappointmenttypebillableitem-delete.md) ## Appointment Type Product ### List appointment type products - [GET /appointment_type_products](https://docs.api.cliniko.com/openapi/appointment-type-product/listappointmenttypeproducts-get.md) ### Create appointment type product - [POST /appointment_type_products](https://docs.api.cliniko.com/openapi/appointment-type-product/createappointmenttypeproduct-post.md) ### Get appointment type product - [GET /appointment_type_products/{id}](https://docs.api.cliniko.com/openapi/appointment-type-product/getappointmenttypeproduct-get.md) ### Update appointment type product - [PATCH /appointment_type_products/{id}](https://docs.api.cliniko.com/openapi/appointment-type-product/updateappointmenttypeproduct-patch.md) ### Delete appointment type product - [DELETE /appointment_type_products/{id}](https://docs.api.cliniko.com/openapi/appointment-type-product/deleteappointmenttypeproduct-delete.md) ## Attendee ### List attendees - [GET /attendees](https://docs.api.cliniko.com/openapi/attendee/listattendees-get.md) ### Create attendee - [POST /attendees](https://docs.api.cliniko.com/openapi/attendee/createattendee-post.md) ### Get attendee - [GET /attendees/{id}](https://docs.api.cliniko.com/openapi/attendee/getattendee-get.md) ### Update attendee - [PATCH /attendees/{id}](https://docs.api.cliniko.com/openapi/attendee/updateattendee-patch.md) ### Archive attendee - [POST /attendees/{id}/archive](https://docs.api.cliniko.com/openapi/attendee/archiveattendee-post.md) ### Cancel attendee - [PATCH /attendees/{id}/cancel](https://docs.api.cliniko.com/openapi/attendee/cancelattendee-patch.md): 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 ### Archive attendee (deprecated) - [DELETE /attendees/{id}](https://docs.api.cliniko.com/openapi/attendee/deleteattendee-delete.md) ### List attendees for group appointment (deprecated) - [GET /group_appointments/{group_appointment_id}/attendees](https://docs.api.cliniko.com/openapi/attendee/listattendeesforgroupappointment-get.md) ### List attendees for individual appointment (deprecated) - [GET /individual_appointments/{individual_appointment_id}/attendees](https://docs.api.cliniko.com/openapi/attendee/listattendeesforindividualappointment-get.md) ### List attendees for patient case (deprecated) - [GET /patient_cases/{patient_case_id}/attendees](https://docs.api.cliniko.com/openapi/attendee/listattendeesforpatientcase-get.md) ## Availability Block ### List availability blocks - [GET /availability_blocks](https://docs.api.cliniko.com/openapi/availability-block/listavailabilityblocks-get.md) ### Create availability block - [POST /availability_blocks](https://docs.api.cliniko.com/openapi/availability-block/createavailabilityblock-post.md) ### Get availability block - [GET /availability_blocks/{id}](https://docs.api.cliniko.com/openapi/availability-block/getavailabilityblock-get.md) ## Available Time 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:

Maximum number of appointments per day segment

Day parts are morning (before Midday), afternoon (Midday to 5pm) and evening (5pm onwards). Possible settings are: 1, 2, 3, 4, 5 or unlimited.

Minimum advance time required for online bookings

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, 6 Hours, 12 Hours, 18 Hours, 1 Day, 2 Days, 3 Days, 1 Week, 2 Weeks, 3 Weeks or 4 Weeks.

How far ahead bookings are offered

This limits how far in the future available times are offered. Possible settings are: 1 Day, 1 Week, 2 Weeks, 4 Weeks, 6 Weeks, 8 Weeks, 12 Weeks, 6 Months, 1 Year, 18 Months or 2 Years

Business to be displayed in online bookings

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.

Appointment Type to be displayed in 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.

Practitioner to be displayed in 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. ### Get all available times - [GET /businesses/{business_id}/practitioners/{practitioner_id}/appointment_types/{appointment_type_id}/available_times](https://docs.api.cliniko.com/openapi/available-time/getallavailabletimes-get.md): Find appointment start times that are currently available for the practitioner based on parameters provided. ### Get next available time - [GET /businesses/{business_id}/practitioners/{practitioner_id}/appointment_types/{appointment_type_id}/next_available_time](https://docs.api.cliniko.com/openapi/available-time/getnextavailabletime-get.md) ## Billable Item ### List billable items - [GET /billable_items](https://docs.api.cliniko.com/openapi/billable-item/listbillableitems-get.md) ### Create billable item - [POST /billable_items](https://docs.api.cliniko.com/openapi/billable-item/createbillableitem-post.md) ### Get billable item - [GET /billable_items/{id}](https://docs.api.cliniko.com/openapi/billable-item/getbillableitem-get.md) ### Update billable item - [PATCH /billable_items/{id}](https://docs.api.cliniko.com/openapi/billable-item/updatebillableitem-patch.md) ### Archive billable item - [POST /billable_items/{id}/archive](https://docs.api.cliniko.com/openapi/billable-item/archivebillableitem-post.md) ### Archive billable item (deprecated) - [DELETE /billable_items/{id}](https://docs.api.cliniko.com/openapi/billable-item/deletebillableitem-delete.md) ## Body Chart ### List body charts - [GET /body_charts](https://docs.api.cliniko.com/openapi/body-chart/listbodycharts-get.md) ### Get body chart - [GET /body_charts/{id}](https://docs.api.cliniko.com/openapi/body-chart/getbodychart-get.md) ## Booking ### List bookings - [GET /bookings](https://docs.api.cliniko.com/openapi/booking/listbookings-get.md) ### Get booking - [GET /bookings/{id}](https://docs.api.cliniko.com/openapi/booking/getbooking-get.md) ### List bookings for patient case (deprecated) - [GET /patient_cases/{patient_case_id}/bookings](https://docs.api.cliniko.com/openapi/booking/listbookingsforpatientcase-get.md) ## Business Businesses represent a business or location (e.g. a clinic). Each Cliniko account can have unlimited businesses. These are typically used for each physical location if there is more than one. Most Cliniko accounts have just one business. ### List businesses - [GET /businesses](https://docs.api.cliniko.com/openapi/business/listbusinesses-get.md) ### Create business - [POST /businesses](https://docs.api.cliniko.com/openapi/business/createbusiness-post.md) ### Get business - [GET /businesses/{id}](https://docs.api.cliniko.com/openapi/business/getbusiness-get.md) ### Update business - [PATCH /businesses/{id}](https://docs.api.cliniko.com/openapi/business/updatebusiness-patch.md) ### Archive business - [POST /businesses/{id}/archive](https://docs.api.cliniko.com/openapi/business/archivebusiness-post.md) ### Unarchive business - [POST /businesses/{id}/unarchive](https://docs.api.cliniko.com/openapi/business/unarchivebusiness-post.md) ### Archive business (deprecated) - [DELETE /businesses/{id}](https://docs.api.cliniko.com/openapi/business/deletebusiness-delete.md) ## Communication ### List communications - [GET /communications](https://docs.api.cliniko.com/openapi/communication/listcommunications-get.md) ### Create memo communication - [POST /communications](https://docs.api.cliniko.com/openapi/communication/creatememocommunication-post.md): Creating a memo with SMS or email as communication type will not send a communication. A memo just records that a communication has taken place. ### Get communication - [GET /communications/{id}](https://docs.api.cliniko.com/openapi/communication/getcommunication-get.md) ### Update memo communication - [PATCH /communications/{id}](https://docs.api.cliniko.com/openapi/communication/updatememocommunication-patch.md) ### Archive memo communication - [POST /communications/{id}/archive](https://docs.api.cliniko.com/openapi/communication/archivememocommunication-post.md) ## Concession Price ### List concession prices - [GET /concession_prices](https://docs.api.cliniko.com/openapi/concession-price/listconcessionprices-get.md) ### Create concession price - [POST /concession_prices](https://docs.api.cliniko.com/openapi/concession-price/createconcessionprice-post.md) ### Get concession price - [GET /concession_prices/{id}](https://docs.api.cliniko.com/openapi/concession-price/getconcessionprice-get.md) ### Update concession price - [PATCH /concession_prices/{id}](https://docs.api.cliniko.com/openapi/concession-price/updateconcessionprice-patch.md) ## Concession Type ### List concession types - [GET /concession_types](https://docs.api.cliniko.com/openapi/concession-type/listconcessiontypes-get.md) ### Create concession type - [POST /concession_types](https://docs.api.cliniko.com/openapi/concession-type/createconcessiontype-post.md) ### Get concession type - [GET /concession_types/{id}](https://docs.api.cliniko.com/openapi/concession-type/getconcessiontype-get.md) ### Update concession type - [PATCH /concession_types/{id}](https://docs.api.cliniko.com/openapi/concession-type/updateconcessiontype-patch.md) ## Contact ### List contacts - [GET /contacts](https://docs.api.cliniko.com/openapi/contact/listcontacts-get.md) ### Create contact - [POST /contacts](https://docs.api.cliniko.com/openapi/contact/createcontact-post.md) ### Get contact - [GET /contacts/{id}](https://docs.api.cliniko.com/openapi/contact/getcontact-get.md) ### Update contact - [PATCH /contacts/{id}](https://docs.api.cliniko.com/openapi/contact/updatecontact-patch.md) ### Archive contact - [POST /contacts/{id}/archive](https://docs.api.cliniko.com/openapi/contact/archivecontact-post.md) ### Archive contact (deprecated) - [DELETE /contacts/{id}](https://docs.api.cliniko.com/openapi/contact/deletecontact-delete.md) ## Daily Availability The regularly scheduled availabilities of a practitioner at a business ### List daily availabilities - [GET /daily_availabilities](https://docs.api.cliniko.com/openapi/daily-availability/listdailyavailabilities-get.md) ### Get daily availability - [GET /daily_availabilities/{id}](https://docs.api.cliniko.com/openapi/daily-availability/getdailyavailability-get.md) ### List daily availabilities for business - [GET /businesses/{business_id}/daily_availabilities](https://docs.api.cliniko.com/openapi/daily-availability/listdailyavailabilitiesforbusiness-get.md) ### List daily availabilities for practitioner - [GET /practitioners/{practitioner_id}/daily_availabilities](https://docs.api.cliniko.com/openapi/daily-availability/listdailyavailabilitiesforpractitioner-get.md) ## Group Appointment ### List group appointments - [GET /group_appointments](https://docs.api.cliniko.com/openapi/group-appointment/listgroupappointments-get.md) ### Create group appointment - [POST /group_appointments](https://docs.api.cliniko.com/openapi/group-appointment/creategroupappointment-post.md) ### Get group appointment - [GET /group_appointments/{id}](https://docs.api.cliniko.com/openapi/group-appointment/getgroupappointment-get.md) ### Update group appointment - [PATCH /group_appointments/{id}](https://docs.api.cliniko.com/openapi/group-appointment/updategroupappointment-patch.md) ### Archive group appointment - [POST /group_appointments/{id}/archive](https://docs.api.cliniko.com/openapi/group-appointment/archivegroupappointment-post.md) ### Get conflicts for a group appointment - [GET /group_appointments/{id}/conflicts](https://docs.api.cliniko.com/openapi/group-appointment/getgroupappointmentconflicts-get.md) ### Archive group appointment (deprecated) - [DELETE /group_appointments/{id}](https://docs.api.cliniko.com/openapi/group-appointment/deletegroupappointment-delete.md) ## Individual Appointment ### List individual appointments - [GET /individual_appointments](https://docs.api.cliniko.com/openapi/individual-appointment/listindividualappointments-get.md) ### Create individual appointment - [POST /individual_appointments](https://docs.api.cliniko.com/openapi/individual-appointment/createindividualappointment-post.md) ### Get individual appointment - [GET /individual_appointments/{id}](https://docs.api.cliniko.com/openapi/individual-appointment/getindividualappointment-get.md) ### Update individual appointment - [PATCH /individual_appointments/{id}](https://docs.api.cliniko.com/openapi/individual-appointment/updateindividualappointment-patch.md) ### Archive individual appointment - [POST /individual_appointments/{id}/archive](https://docs.api.cliniko.com/openapi/individual-appointment/archiveindividualappointment-post.md) ### Cancel individual appointment - [PATCH /individual_appointments/{id}/cancel](https://docs.api.cliniko.com/openapi/individual-appointment/cancelindividualappointment-patch.md) ### Get conflicts for an individual appointment - [GET /individual_appointments/{id}/conflicts](https://docs.api.cliniko.com/openapi/individual-appointment/getindividualappointmentconflicts-get.md) ### Archive individual appointment (deprecated) - [DELETE /individual_appointments/{id}](https://docs.api.cliniko.com/openapi/individual-appointment/deleteindividualappointment-delete.md) ## Invoice ### List invoices - [GET /invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoices-get.md) ### Get invoice - [GET /invoices/{id}](https://docs.api.cliniko.com/openapi/invoice/getinvoice-get.md) ### List invoices for appointment - [GET /appointments/{appointment_id}/invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoicesforappointment-get.md) ### List invoices for patient case - [GET /patient_cases/{patient_case_id}/invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoicesforpatientcase-get.md) ### List invoices for attendee (deprecated) - [GET /attendees/{attendee_id}/invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoicesforattendee-get.md) ### List invoices for patient (deprecated) - [GET /patients/{patient_id}/invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoicesforpatient-get.md) ### List invoices for practitioner (deprecated) - [GET /practitioners/{practitioner_id}/invoices](https://docs.api.cliniko.com/openapi/invoice/listinvoicesforpractitioner-get.md) ## Invoice Item ### List invoice items - [GET /invoice_items](https://docs.api.cliniko.com/openapi/invoice-item/listinvoiceitems-get.md) ### Get invoice item - [GET /invoice_items/{id}](https://docs.api.cliniko.com/openapi/invoice-item/getinvoiceitem-get.md) ### List invoice items for invoice (deprecated) - [GET /invoices/{invoice_id}/invoice_items](https://docs.api.cliniko.com/openapi/invoice-item/listinvoiceitemsforinvoice-get.md) ## Medical Alert ### List medical alerts - [GET /medical_alerts](https://docs.api.cliniko.com/openapi/medical-alert/listmedicalalerts-get.md) ### Create medical alert - [POST /medical_alerts](https://docs.api.cliniko.com/openapi/medical-alert/createmedicalalert-post.md) ### Get medical alert - [GET /medical_alerts/{id}](https://docs.api.cliniko.com/openapi/medical-alert/getmedicalalert-get.md) ### Update medical alert - [PATCH /medical_alerts/{id}](https://docs.api.cliniko.com/openapi/medical-alert/updatemedicalalert-patch.md) ### Delete medical alert - [DELETE /medical_alerts/{id}](https://docs.api.cliniko.com/openapi/medical-alert/deletemedicalalert-delete.md) ### List medical alerts for patient (deprecated) - [GET /patients/{patient_id}/medical_alerts](https://docs.api.cliniko.com/openapi/medical-alert/listmedicalalertsforpatient-get.md) ## Patient 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. ### List patients - [GET /patients](https://docs.api.cliniko.com/openapi/patient/listpatients-get.md) ### Create patient - [POST /patients](https://docs.api.cliniko.com/openapi/patient/createpatient-post.md) ### Get patient - [GET /patients/{id}](https://docs.api.cliniko.com/openapi/patient/getpatient-get.md) ### Update patient - [PATCH /patients/{id}](https://docs.api.cliniko.com/openapi/patient/updatepatient-patch.md) ### Archive patient - [POST /patients/{id}/archive](https://docs.api.cliniko.com/openapi/patient/archivepatient-post.md) ### Unarchive patient - [POST /patients/{id}/unarchive](https://docs.api.cliniko.com/openapi/patient/unarchivepatient-post.md) ### Archive patient (deprecated) - [DELETE /patients/{id}](https://docs.api.cliniko.com/openapi/patient/archivepatient-delete.md) ## Patient Attachment ### List patient attachments - [GET /patient_attachments](https://docs.api.cliniko.com/openapi/patient-attachment/listpatientattachments-get.md) ### Create uploaded patient attachment - [POST /patient_attachments](https://docs.api.cliniko.com/openapi/patient-attachment/createuploadedpatientattachment-post.md): To create a patient attachment, you must first generate a presigned URL, upload your file to that URL, and then supply that URL and response key in the upload_url request body parameter. ### Get patient attachment - [GET /patient_attachments/{id}](https://docs.api.cliniko.com/openapi/patient-attachment/getpatientattachment-get.md) ### Update patient attachment - [PATCH /patient_attachments/{id}](https://docs.api.cliniko.com/openapi/patient-attachment/updatepatientattachment-patch.md) ### Archive patient attachment - [POST /patient_attachments/{id}/archive](https://docs.api.cliniko.com/openapi/patient-attachment/archivepatientattachment-post.md) ### List patient attachments for patient case - [GET /patient_cases/{patient_case_id}/patient_attachments](https://docs.api.cliniko.com/openapi/patient-attachment/listpatientattachmentsforpatientcase-get.md) ### Get a presigned URL to upload your file to S3 - [GET /patients/{patient_id}/attachment_presigned_post](https://docs.api.cliniko.com/openapi/patient-attachment/presignedpost-get.md) ### Archive patient attachment (deprecated) - [DELETE /patient_attachments/{id}](https://docs.api.cliniko.com/openapi/patient-attachment/deletepatientattachment-delete.md) ### List patient attachments for patient (deprecated) - [GET /patients/{patient_id}/patient_attachments](https://docs.api.cliniko.com/openapi/patient-attachment/listpatientattachmentsforpatient-get.md) ## Patient Case ### List patient cases - [GET /patient_cases](https://docs.api.cliniko.com/openapi/patient-case/listpatientcases-get.md) ### Create patient case - [POST /patient_cases](https://docs.api.cliniko.com/openapi/patient-case/createpatientcase-post.md) ### List active patient cases - [GET /patient_cases/active](https://docs.api.cliniko.com/openapi/patient-case/listactivepatientcases-get.md) ### Get patient case - [GET /patient_cases/{id}](https://docs.api.cliniko.com/openapi/patient-case/getpatientcase-get.md) ### Update patient case - [PATCH /patient_cases/{id}](https://docs.api.cliniko.com/openapi/patient-case/updatepatientcase-patch.md) ### Archive patient case - [POST /patient_cases/{id}/archive](https://docs.api.cliniko.com/openapi/patient-case/archivepatientcase-post.md) ## Patient Form 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 identified as unsupported HTML and will be stripped. ### List patient forms - [GET /patient_forms](https://docs.api.cliniko.com/openapi/patient-form/listpatientforms-get.md) ### Create patient form - [POST /patient_forms](https://docs.api.cliniko.com/openapi/patient-form/createpatientform-post.md): When creating a patient form with a patient_form_template_id, the values for name, content, and restricted_to_practitioner will be pulled from the template. However, you may provide any of those values to override the template, or even provide all of your own values and exclude the patient_form_template_id altogether. ### Get patient form - [GET /patient_forms/{id}](https://docs.api.cliniko.com/openapi/patient-form/getpatientform-get.md) ### Update patient form - [PATCH /patient_forms/{id}](https://docs.api.cliniko.com/openapi/patient-form/updatepatientform-patch.md) ### Archive patient form - [POST /patient_forms/{id}/archive](https://docs.api.cliniko.com/openapi/patient-form/archivepatientform-post.md) ### List patient forms for attendee (deprecated) - [GET /attendees/{attendee_id}/patient_forms](https://docs.api.cliniko.com/openapi/patient-form/listpatientformsforattendee-get.md) ## Patient Form Template ### List patient form templates - [GET /patient_form_templates](https://docs.api.cliniko.com/openapi/patient-form-template/listpatientformtemplates-get.md) ### Create patient form template - [POST /patient_form_templates](https://docs.api.cliniko.com/openapi/patient-form-template/createpatientformtemplate-post.md) ### Get patient form template - [GET /patient_form_templates/{id}](https://docs.api.cliniko.com/openapi/patient-form-template/getpatientformtemplate-get.md) ### Update patient form template - [PATCH /patient_form_templates/{id}](https://docs.api.cliniko.com/openapi/patient-form-template/updatepatientformtemplate-patch.md) ### Archive patient form template - [POST /patient_form_templates/{id}/archive](https://docs.api.cliniko.com/openapi/patient-form-template/archivepatientformtemplate-post.md) ## Practitioner All practitioners have an associated user account. Not all users are practitioners (e.g. receptionists wouldn't be). You can only create appointments for practitioners (not for users). ### List practitioners - [GET /practitioners](https://docs.api.cliniko.com/openapi/practitioner/listpractitioners-get.md) ### List inactive practitioners - [GET /practitioners/inactive](https://docs.api.cliniko.com/openapi/practitioner/listinactivepractitioners-get.md) ### Get practitioner - [GET /practitioners/{id}](https://docs.api.cliniko.com/openapi/practitioner/getpractitioner-get.md) ### List practitioners for appointment type - [GET /appointment_types/{appointment_type_id}/practitioners](https://docs.api.cliniko.com/openapi/practitioner/listpractitionersforappointmenttype-get.md) ### List practitioners for business - [GET /businesses/{business_id}/practitioners](https://docs.api.cliniko.com/openapi/practitioner/listpractitionersforbusiness-get.md) ### List inactive practitioners for appointment type - [GET /appointment_types/{appointment_type_id}/practitioners/inactive](https://docs.api.cliniko.com/openapi/practitioner/listinactivepractitionersforappointmenttype-get.md) ### List inactive practitioners for business - [GET /businesses/{business_id}/practitioners/inactive](https://docs.api.cliniko.com/openapi/practitioner/listinactivepractitionersforbusiness-get.md) ## Practitioner Reference Number ### List practitioner reference numbers - [GET /practitioner_reference_numbers](https://docs.api.cliniko.com/openapi/practitioner-reference-number/listpractitionerreferencenumbers-get.md) ### Create practitioner reference number - [POST /practitioner_reference_numbers](https://docs.api.cliniko.com/openapi/practitioner-reference-number/createpractitionerreferencenumber-post.md) ### Get practitioner reference number - [GET /practitioner_reference_numbers/{id}](https://docs.api.cliniko.com/openapi/practitioner-reference-number/getpractitionerreferencenumber-get.md) ### Update practitioner reference number - [PATCH /practitioner_reference_numbers/{id}](https://docs.api.cliniko.com/openapi/practitioner-reference-number/updatepractitionerreferencenumber-patch.md) ### Delete practitioner reference number - [DELETE /practitioner_reference_numbers/{id}](https://docs.api.cliniko.com/openapi/practitioner-reference-number/deletepractitionerreferencenumber-delete.md) ### List practitioner reference numbers for practitioner (deprecated) - [GET /practitioners/{practitioner_id}/practitioner_reference_numbers](https://docs.api.cliniko.com/openapi/practitioner-reference-number/listpractitionerreferencenumbersforpractitioner-get.md) ## Product ### List products - [GET /products](https://docs.api.cliniko.com/openapi/product/listproducts-get.md) ### Create product - [POST /products](https://docs.api.cliniko.com/openapi/product/createproduct-post.md) ### Get product - [GET /products/{id}](https://docs.api.cliniko.com/openapi/product/getproduct-get.md) ### Update product - [PATCH /products/{id}](https://docs.api.cliniko.com/openapi/product/updateproduct-patch.md) ### Archive product - [POST /products/{id}/archive](https://docs.api.cliniko.com/openapi/product/archiveproduct-post.md) ### Archive product (deprecated) - [DELETE /products/{id}](https://docs.api.cliniko.com/openapi/product/deleteproduct-delete.md) ## Product Supplier ### List product suppliers - [GET /product_suppliers](https://docs.api.cliniko.com/openapi/product-supplier/listproductsuppliers-get.md) ### Create product supplier - [POST /product_suppliers](https://docs.api.cliniko.com/openapi/product-supplier/createproductsupplier-post.md) ### Get product supplier - [GET /product_suppliers/{id}](https://docs.api.cliniko.com/openapi/product-supplier/getproductsupplier-get.md) ### Update product supplier - [PATCH /product_suppliers/{id}](https://docs.api.cliniko.com/openapi/product-supplier/updateproductsupplier-patch.md) ### Delete product supplier - [DELETE /product_suppliers/{id}](https://docs.api.cliniko.com/openapi/product-supplier/deleteproductsupplier-delete.md) ## Public Settings ### Get public settings - [GET /settings/public](https://docs.api.cliniko.com/openapi/public-settings/getpublicsettings-get.md) ## Recall ### List recalls - [GET /recalls](https://docs.api.cliniko.com/openapi/recall/listrecalls-get.md) ### Create recall - [POST /recalls](https://docs.api.cliniko.com/openapi/recall/createrecall-post.md) ### Get recall - [GET /recalls/{id}](https://docs.api.cliniko.com/openapi/recall/getrecall-get.md) ### Update recall - [PATCH /recalls/{id}](https://docs.api.cliniko.com/openapi/recall/updaterecall-patch.md) ### Archive recall - [POST /recalls/{id}/archive](https://docs.api.cliniko.com/openapi/recall/archiverecall-post.md) ## Recall Type ### List recall types - [GET /recall_types](https://docs.api.cliniko.com/openapi/recall-type/listrecalltypes-get.md) ### Create recall type - [POST /recall_types](https://docs.api.cliniko.com/openapi/recall-type/createrecalltype-post.md) ### Get recall type - [GET /recall_types/{id}](https://docs.api.cliniko.com/openapi/recall-type/getrecalltype-get.md) ### Update recall type - [PATCH /recall_types/{id}](https://docs.api.cliniko.com/openapi/recall-type/updaterecalltype-patch.md) ### Archive recall type - [POST /recall_types/{id}/archive](https://docs.api.cliniko.com/openapi/recall-type/archiverecalltype-post.md) ## Referral Source Referral source of a patient ### List referral sources - [GET /referral_sources](https://docs.api.cliniko.com/openapi/referral-source/listreferralsources-get.md) ### Get referral source - [GET /patients/{patient_id}/referral_source](https://docs.api.cliniko.com/openapi/referral-source/getreferralsource-get.md) ### Update referral source - [PATCH /patients/{patient_id}/referral_source](https://docs.api.cliniko.com/openapi/referral-source/updatereferralsource-patch.md) ## Referral Source Type Types of referrals for patients ### List referral source types - [GET /referral_source_types](https://docs.api.cliniko.com/openapi/referral-source-type/listreferralsourcetypes-get.md) ### Get referral source type - [GET /referral_source_types/{id}](https://docs.api.cliniko.com/openapi/referral-source-type/getreferralsourcetype-get.md) ## Relationship ### List relationships - [GET /relationships](https://docs.api.cliniko.com/openapi/relationship/listrelationships-get.md) ### Create relationship - [POST /relationships](https://docs.api.cliniko.com/openapi/relationship/createrelationship-post.md) ### Get relationship - [GET /relationships/{id}](https://docs.api.cliniko.com/openapi/relationship/getrelationship-get.md) ### Update relationship - [PATCH /relationships/{id}](https://docs.api.cliniko.com/openapi/relationship/updaterelationship-patch.md) ### Archive relationship - [POST /relationships/{id}/archive](https://docs.api.cliniko.com/openapi/relationship/archiverelationship-post.md) ## Service ### List services - [GET /services](https://docs.api.cliniko.com/openapi/service/listservices-get.md) ### List services for business - [GET /businesses/{business_id}/services](https://docs.api.cliniko.com/openapi/service/listservicesforbusiness-get.md) ## Settings ### Get settings - [GET /settings](https://docs.api.cliniko.com/openapi/settings/getsettings-get.md): This endpoint is only accessible to users with a role that can view settings. ## Signature ### Get signature - [GET /patient_forms/{patient_form_id}/signatures/{id}](https://docs.api.cliniko.com/openapi/signature/getsignature-get.md) ## Stock Adjustment ### List stock adjustments - [GET /stock_adjustments](https://docs.api.cliniko.com/openapi/stock-adjustment/liststockadjustments-get.md) ### Create stock adjustment - [POST /stock_adjustments](https://docs.api.cliniko.com/openapi/stock-adjustment/createstockadjustment-post.md) ### Get stock adjustment - [GET /stock_adjustments/{id}](https://docs.api.cliniko.com/openapi/stock-adjustment/getstockadjustment-get.md) ## Tax ### List taxes - [GET /taxes](https://docs.api.cliniko.com/openapi/tax/listtaxes-get.md) ### Create tax - [POST /taxes](https://docs.api.cliniko.com/openapi/tax/createtax-post.md) ### Get tax - [GET /taxes/{id}](https://docs.api.cliniko.com/openapi/tax/gettax-get.md) ### Update tax - [PATCH /taxes/{id}](https://docs.api.cliniko.com/openapi/tax/updatetax-patch.md) ### Delete tax - [DELETE /taxes/{id}](https://docs.api.cliniko.com/openapi/tax/deletetax-delete.md) ## Treatment Note 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 identified as unsupported HTML and will be stripped. ### List treatment notes - [GET /treatment_notes](https://docs.api.cliniko.com/openapi/treatment-note/listtreatmentnotes-get.md) ### Create treatment note - [POST /treatment_notes](https://docs.api.cliniko.com/openapi/treatment-note/createtreatmentnote-post.md) ### Get treatment note - [GET /treatment_notes/{id}](https://docs.api.cliniko.com/openapi/treatment-note/gettreatmentnote-get.md) ### Update treatment note - [PATCH /treatment_notes/{id}](https://docs.api.cliniko.com/openapi/treatment-note/updatetreatmentnote-patch.md) ### List treatment notes for patient - [GET /patients/{patient_id}/treatment_notes](https://docs.api.cliniko.com/openapi/treatment-note/listtreatmentnotesforpatient-get.md) ### Archive treatment note - [POST /treatment_notes/{id}/archive](https://docs.api.cliniko.com/openapi/treatment-note/archivetreatmentnote-post.md) ### Unarchive treatment note - [POST /treatment_notes/{id}/unarchive](https://docs.api.cliniko.com/openapi/treatment-note/unarchivetreatmentnote-post.md) ### Archive treatment note (deprecated) - [DELETE /treatment_notes/{id}](https://docs.api.cliniko.com/openapi/treatment-note/deletetreatmentnote-delete.md) ## Treatment Note Template 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 identified as unsupported HTML and will be stripped. ### List treatment note templates - [GET /treatment_note_templates](https://docs.api.cliniko.com/openapi/treatment-note-template/listtreatmentnotetemplates-get.md) ### Create treatment note template - [POST /treatment_note_templates](https://docs.api.cliniko.com/openapi/treatment-note-template/createtreatmentnotetemplate-post.md) ### Get treatment note template - [GET /treatment_note_templates/{id}](https://docs.api.cliniko.com/openapi/treatment-note-template/gettreatmentnotetemplate-get.md) ### Update treatment note template - [PATCH /treatment_note_templates/{id}](https://docs.api.cliniko.com/openapi/treatment-note-template/updatetreatmentnotetemplate-patch.md) ### Archive treatment note template - [POST /treatment_note_templates/{id}/archive](https://docs.api.cliniko.com/openapi/treatment-note-template/archivetreatmentnotetemplate-post.md) ### Archive treatment note template (deprecated) - [DELETE /treatment_note_templates/{id}](https://docs.api.cliniko.com/openapi/treatment-note-template/deletetreatmentnotetemplate-delete.md) ## Unavailable Block ### List unavailable blocks - [GET /unavailable_blocks](https://docs.api.cliniko.com/openapi/unavailable-block/listunavailableblocks-get.md) ### Create unavailable block - [POST /unavailable_blocks](https://docs.api.cliniko.com/openapi/unavailable-block/createunavailableblock-post.md) ### Get unavailable block - [GET /unavailable_blocks/{id}](https://docs.api.cliniko.com/openapi/unavailable-block/getunavailableblock-get.md) ### Update unavailable block - [PATCH /unavailable_blocks/{id}](https://docs.api.cliniko.com/openapi/unavailable-block/updateunavailableblock-patch.md) ### Archive unavailable block - [POST /unavailable_blocks/{id}/archive](https://docs.api.cliniko.com/openapi/unavailable-block/archiveunavailableblock-post.md) ### Get conflicts for an unavailable block - [GET /unavailable_blocks/{id}/conflicts](https://docs.api.cliniko.com/openapi/unavailable-block/getunavailableblockconflicts-get.md) ### Archive unavailable block (deprecated) - [DELETE /unavailable_blocks/{id}](https://docs.api.cliniko.com/openapi/unavailable-block/deleteunavailableblock-delete.md) ## Unavailable Block Type ### List unavailable block types - [GET /unavailable_block_types](https://docs.api.cliniko.com/openapi/unavailable-block-type/listunavailableblocktypes-get.md) ### Create unavailable block type - [POST /unavailable_block_types](https://docs.api.cliniko.com/openapi/unavailable-block-type/createunavailableblocktype-post.md) ### Get unavailable block type - [GET /unavailable_block_types/{id}](https://docs.api.cliniko.com/openapi/unavailable-block-type/getunavailableblocktype-get.md) ### Update unavailable block type - [PATCH /unavailable_block_types/{id}](https://docs.api.cliniko.com/openapi/unavailable-block-type/updateunavailableblocktype-patch.md) ### Archive unavailable block type - [POST /unavailable_block_types/{id}/archive](https://docs.api.cliniko.com/openapi/unavailable-block-type/archiveunavailableblocktype-post.md) ## User ### Get authenticated user - [GET /user](https://docs.api.cliniko.com/openapi/user/getauthenticateduser-get.md) ### List users - [GET /users](https://docs.api.cliniko.com/openapi/user/listusers-get.md) ### Get user - [GET /users/{id}](https://docs.api.cliniko.com/openapi/user/getuser-get.md)