Skip to content

Cliniko API (v1)

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.

Download OpenAPI description
Languages
Servers
Production
https://api.au1.cliniko.com/v1

Appointment Type

Schemas
Operations

Appointment Type Billable Item

Schemas
Operations

Appointment Type Product

Schemas
Operations

Attendee

Schemas
Operations

Availability Block

Schemas
Operations

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, Tomorrow or 2 Days.

How far ahead bookings are offered

This limits how far in the future available times are offered.

Possible settings are: 28 days, 84 days, 182 days or 365 days

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.

Schemas
Operations

Billable Item

Schemas
Operations

Booking

Schemas
Operations

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.

Schemas
Operations

Communication

Schemas
Operations

Concession Price

Schemas
Operations

Concession Type

Schemas
Operations

Contact

Schemas
Operations

Daily Availability

The regularly scheduled availabilities of a practitioner at a business

Schemas
Operations

Group Appointment

Schemas
Operations

Individual Appointment

Schemas
Operations

Invoice

Schemas
Operations

Invoice Item

Schemas
Operations

Medical Alert

Schemas
Operations

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.

Schemas
Operations

Patient

accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
accepted_sms_marketingboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
appointmentsobject
archived_atstring or null(date-time)
attendeesobject
citystring or null<= 255 characters
concession_typeobject
country_codestring or null

ISO 3166-1 country code

Example: "AU"
created_atstring(date-time)
custom_fieldsobject or null
date_of_birthstring or null(date)
deleted_atstring or null(date-time)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
follow_ups_communication_channelsArray of integers

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
follow_ups_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
gender_identitystring or null
idstring(int64)
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
invoicesobject
labelstring or null

Full name

last_namestring<= 255 characters
latest_bookingobject
linksobject
medical_alertsobject
medicarestring or null<= 255 characters
medicare_reference_numberstring or null<= 255 characters
merged_atstring or null(date-time)
merged_with_patientobject
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
patient_attachmentsobject
patient_phone_numbersArray of objects or null(PhoneNumber)
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctorobject
relationshipsobject
reminders_communication_channelsArray of integers

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
updated_atstring(date-time)
countrystring or nullDeprecated
genderstring or nullDeprecated
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
{ "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/appointments" } }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1" } }, "city": "string", "concession_type": { "links": { "self": "https://api.au1.cliniko.com/v1/concession_types/1" } }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [ { "name": "string", "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70", "archived": true, "fields": [] } ] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/invoices" } }, "label": "string", "last_name": "string", "latest_booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts" } }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments" } }, "patient_phone_numbers": [ { "normalized_number": "39012345678", "number": "0-123-456-78", "phone_type": "Fax" } ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": { "self": "https://api.au1.cliniko.com/v1/contacts/1" } }, "relationships": { "links": { "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1" } }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }

List patients

Request

Security
basicAuth
Query
pageinteger
per_pageinteger[ 1 .. 100 ]
sortArray of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
q[]Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
accepted_privacy_policyboolean
archived_atdate-time
created_atdate-time
date_of_birthdate
emailstring
first_namestring
idint64
last_namestring
old_reference_idstring
preferred_first_namestring
updated_atdate-time
orderstringDeprecated
Enum"asc""desc"
curl -i -X GET \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients?page=0&per_page=1&sort=created_at%3Adesc&q%5B%5D=string&order=asc'

Responses

successful operation

Bodyapplication/json
patientsArray of objects(Patient)
total_entriesinteger
Example: 1
linksobject
Response
application/json
{ "patients": [ { "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": {} }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": {} }, "city": "string", "concession_type": { "links": {} }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": {} }, "label": "string", "last_name": "string", "latest_booking": { "links": {} }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": {} }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": {} }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": {} }, "patient_phone_numbers": [ {} ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": {} }, "relationships": { "links": {} }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "total_entries": 1, "links": { "self": "https://api.au1.cliniko.com/v1/patients?page=2", "previous": "https://api.au1.cliniko.com/v1/patients?page=1", "next": "https://api.au1.cliniko.com/v1/patients?page=3" } }

Create patient

Request

Security
basicAuth
Bodyapplication/jsonrequired
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
citystring or null<= 255 characters
concession_type_idstring(int64)

concession type id

Example: "1"
countrystring or null
country_codestring or null

ISO 3166-1 country code

Example: "AU"
custom_fieldsobject or null
date_of_birthstring or null(date)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
gender_identitystring or null
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
last_namestring<= 255 characters
medicare_reference_numberstring or null<= 255 characters
medicarestring or null<= 255 characters
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctor_idstring(int64)

contact id

Example: "1"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
unsubscribe_sms_marketingboolean
follow_ups_communication_channelsArray of integers

The array of communication channels that will be used for this patient's follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channelsArray of integers

The array of communication channels that will be used for this patient's reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
patient_phone_numbersArray of objects
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
curl -i -X POST \
  -u <username>:<password> \
  https://api.au1.cliniko.com/v1/patients \
  -H 'Content-Type: application/json' \
  -d '{
    "accepted_email_marketing": true,
    "accepted_privacy_policy": true,
    "address_1": "string",
    "address_2": "string",
    "address_3": "string",
    "appointment_notes": "string",
    "city": "string",
    "concession_type_id": "1",
    "country": "string",
    "country_code": "AU",
    "custom_fields": {
      "sections": [
        {
          "name": "string",
          "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
          "archived": true,
          "fields": [
            {
              "value": "string",
              "archived": true,
              "name": "string",
              "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
              "type": "text"
            }
          ]
        }
      ]
    },
    "date_of_birth": "2019-08-24",
    "dva_card_number": "string",
    "email": "string",
    "emergency_contact": "string",
    "first_name": "string",
    "gender_identity": "string",
    "invoice_default_to": "string",
    "invoice_email": "string",
    "invoice_extra_information": "string",
    "last_name": "string",
    "medicare_reference_number": "string",
    "medicare": "string",
    "notes": "string",
    "occupation": "string",
    "old_reference_id": "string",
    "post_code": "string",
    "preferred_first_name": "string",
    "pronouns": {
      "accusative": "string",
      "nominative": "string",
      "predicative_possessive": "string",
      "pronominal_possessive": "string",
      "reflexive": "string"
    },
    "receives_cancellation_emails": true,
    "receives_confirmation_emails": true,
    "referral_source": "string",
    "referring_doctor_id": "1",
    "reminder_type": "None",
    "sex": "string",
    "state": "string",
    "time_zone": "Australia/Melbourne",
    "title": "string",
    "unsubscribe_sms_marketing": true,
    "follow_ups_communication_channels": [
      1,
      2
    ],
    "reminders_communication_channels": [
      1,
      2
    ],
    "patient_phone_numbers": [
      {
        "number": "0-123-456-78",
        "phone_type": "Fax"
      }
    ]
  }'

Responses

Resource was created

Bodyapplication/json
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
accepted_sms_marketingboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
appointmentsobject
archived_atstring or null(date-time)
attendeesobject
citystring or null<= 255 characters
concession_typeobject
country_codestring or null

ISO 3166-1 country code

Example: "AU"
created_atstring(date-time)
custom_fieldsobject or null
date_of_birthstring or null(date)
deleted_atstring or null(date-time)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
follow_ups_communication_channelsArray of integers

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
follow_ups_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
gender_identitystring or null
idstring(int64)
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
invoicesobject
labelstring or null

Full name

last_namestring<= 255 characters
latest_bookingobject
linksobject
medical_alertsobject
medicarestring or null<= 255 characters
medicare_reference_numberstring or null<= 255 characters
merged_atstring or null(date-time)
merged_with_patientobject
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
patient_attachmentsobject
patient_phone_numbersArray of objects or null(PhoneNumber)
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctorobject
relationshipsobject
reminders_communication_channelsArray of integers

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
updated_atstring(date-time)
countrystring or nullDeprecated
genderstring or nullDeprecated
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
Response
application/json
{ "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/appointments" } }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1" } }, "city": "string", "concession_type": { "links": { "self": "https://api.au1.cliniko.com/v1/concession_types/1" } }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [ { "name": "string", "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70", "archived": true, "fields": [] } ] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/invoices" } }, "label": "string", "last_name": "string", "latest_booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts" } }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments" } }, "patient_phone_numbers": [ { "normalized_number": "39012345678", "number": "0-123-456-78", "phone_type": "Fax" } ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": { "self": "https://api.au1.cliniko.com/v1/contacts/1" } }, "relationships": { "links": { "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1" } }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }

Get patient

Request

Security
basicAuth
Path
idstring(int64)required
Query
q[]Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
archived_atdate-time
curl -i -X GET \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients/{id}?q%5B%5D=string'

Responses

Successful operation

Bodyapplication/json
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
accepted_sms_marketingboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
appointmentsobject
archived_atstring or null(date-time)
attendeesobject
citystring or null<= 255 characters
concession_typeobject
country_codestring or null

ISO 3166-1 country code

Example: "AU"
created_atstring(date-time)
custom_fieldsobject or null
date_of_birthstring or null(date)
deleted_atstring or null(date-time)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
follow_ups_communication_channelsArray of integers

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
follow_ups_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
gender_identitystring or null
idstring(int64)
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
invoicesobject
labelstring or null

Full name

last_namestring<= 255 characters
latest_bookingobject
linksobject
medical_alertsobject
medicarestring or null<= 255 characters
medicare_reference_numberstring or null<= 255 characters
merged_atstring or null(date-time)
merged_with_patientobject
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
patient_attachmentsobject
patient_phone_numbersArray of objects or null(PhoneNumber)
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctorobject
relationshipsobject
reminders_communication_channelsArray of integers

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
updated_atstring(date-time)
countrystring or nullDeprecated
genderstring or nullDeprecated
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
Response
application/json
{ "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/appointments" } }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1" } }, "city": "string", "concession_type": { "links": { "self": "https://api.au1.cliniko.com/v1/concession_types/1" } }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [ { "name": "string", "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70", "archived": true, "fields": [] } ] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/invoices" } }, "label": "string", "last_name": "string", "latest_booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts" } }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments" } }, "patient_phone_numbers": [ { "normalized_number": "39012345678", "number": "0-123-456-78", "phone_type": "Fax" } ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": { "self": "https://api.au1.cliniko.com/v1/contacts/1" } }, "relationships": { "links": { "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1" } }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }

Update patient

Request

Security
basicAuth
Path
idstring(int64)required
Bodyapplication/jsonrequired
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
citystring or null<= 255 characters
concession_type_idstring(int64)

concession type id

Example: "1"
countrystring or null
country_codestring or null

ISO 3166-1 country code

Example: "AU"
custom_fieldsobject or null
date_of_birthstring or null(date)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
gender_identitystring or null
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
last_namestring<= 255 characters
medicare_reference_numberstring or null<= 255 characters
medicarestring or null<= 255 characters
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctor_idstring(int64)

contact id

Example: "1"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
unsubscribe_sms_marketingboolean
follow_ups_communication_channelsArray of integers

The array of communication channels that will be used for this patient's follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channelsArray of integers

The array of communication channels that will be used for this patient's reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
patient_phone_numbersArray of objects
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
curl -i -X PATCH \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accepted_email_marketing": true,
    "accepted_privacy_policy": true,
    "address_1": "string",
    "address_2": "string",
    "address_3": "string",
    "appointment_notes": "string",
    "city": "string",
    "concession_type_id": "1",
    "country": "string",
    "country_code": "AU",
    "custom_fields": {
      "sections": [
        {
          "name": "string",
          "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
          "archived": true,
          "fields": [
            {
              "value": "string",
              "archived": true,
              "name": "string",
              "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
              "type": "text"
            }
          ]
        }
      ]
    },
    "date_of_birth": "2019-08-24",
    "dva_card_number": "string",
    "email": "string",
    "emergency_contact": "string",
    "first_name": "string",
    "gender_identity": "string",
    "invoice_default_to": "string",
    "invoice_email": "string",
    "invoice_extra_information": "string",
    "last_name": "string",
    "medicare_reference_number": "string",
    "medicare": "string",
    "notes": "string",
    "occupation": "string",
    "old_reference_id": "string",
    "post_code": "string",
    "preferred_first_name": "string",
    "pronouns": {
      "accusative": "string",
      "nominative": "string",
      "predicative_possessive": "string",
      "pronominal_possessive": "string",
      "reflexive": "string"
    },
    "receives_cancellation_emails": true,
    "receives_confirmation_emails": true,
    "referral_source": "string",
    "referring_doctor_id": "1",
    "reminder_type": "None",
    "sex": "string",
    "state": "string",
    "time_zone": "Australia/Melbourne",
    "title": "string",
    "unsubscribe_sms_marketing": true,
    "follow_ups_communication_channels": [
      1,
      2
    ],
    "reminders_communication_channels": [
      1,
      2
    ],
    "patient_phone_numbers": [
      {
        "number": "0-123-456-78",
        "phone_type": "Fax"
      }
    ]
  }'

Responses

Resource was updated

Bodyapplication/json
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
accepted_sms_marketingboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
appointmentsobject
archived_atstring or null(date-time)
attendeesobject
citystring or null<= 255 characters
concession_typeobject
country_codestring or null

ISO 3166-1 country code

Example: "AU"
created_atstring(date-time)
custom_fieldsobject or null
date_of_birthstring or null(date)
deleted_atstring or null(date-time)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
follow_ups_communication_channelsArray of integers

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
follow_ups_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
gender_identitystring or null
idstring(int64)
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
invoicesobject
labelstring or null

Full name

last_namestring<= 255 characters
latest_bookingobject
linksobject
medical_alertsobject
medicarestring or null<= 255 characters
medicare_reference_numberstring or null<= 255 characters
merged_atstring or null(date-time)
merged_with_patientobject
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
patient_attachmentsobject
patient_phone_numbersArray of objects or null(PhoneNumber)
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctorobject
relationshipsobject
reminders_communication_channelsArray of integers

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
updated_atstring(date-time)
countrystring or nullDeprecated
genderstring or nullDeprecated
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
Response
application/json
{ "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/appointments" } }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1" } }, "city": "string", "concession_type": { "links": { "self": "https://api.au1.cliniko.com/v1/concession_types/1" } }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [ { "name": "string", "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70", "archived": true, "fields": [] } ] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/invoices" } }, "label": "string", "last_name": "string", "latest_booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts" } }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments" } }, "patient_phone_numbers": [ { "normalized_number": "39012345678", "number": "0-123-456-78", "phone_type": "Fax" } ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": { "self": "https://api.au1.cliniko.com/v1/contacts/1" } }, "relationships": { "links": { "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1" } }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }

Archive patient

Request

Security
basicAuth
Path
idstring(int64)required
curl -i -X POST \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients/{id}/archive'

Responses

Resource was archived

Unarchive patient

Request

Security
basicAuth
Path
idstring(int64)required
curl -i -X POST \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients/{id}/unarchive'

Responses

Resource was unarchived

Bodyapplication/json
accepted_email_marketingboolean or null
accepted_privacy_policyboolean or null
accepted_sms_marketingboolean or null
address_1string or null<= 255 characters
address_2string or null<= 255 characters
address_3string or null<= 255 characters
appointment_notesstring or null
appointmentsobject
archived_atstring or null(date-time)
attendeesobject
citystring or null<= 255 characters
concession_typeobject
country_codestring or null

ISO 3166-1 country code

Example: "AU"
created_atstring(date-time)
custom_fieldsobject or null
date_of_birthstring or null(date)
deleted_atstring or null(date-time)
dva_card_numberstring or null^[NVQSWT]([A-Z ][0-9]{1,6}|[A-Z]{2}[0-9]{1,5}...
emailstring or null<= 255 characters^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
emergency_contactstring or null<= 255 characters
first_namestring<= 255 characters
follow_ups_communication_channelsArray of integers

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
follow_ups_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
gender_identitystring or null
idstring(int64)
invoice_default_tostring or null
invoice_emailstring or null^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
invoice_extra_informationstring or null
invoicesobject
labelstring or null

Full name

last_namestring<= 255 characters
latest_bookingobject
linksobject
medical_alertsobject
medicarestring or null<= 255 characters
medicare_reference_numberstring or null<= 255 characters
merged_atstring or null(date-time)
merged_with_patientobject
notesstring or null
occupationstring or null<= 255 characters
old_reference_idstring or null<= 255 characters
patient_attachmentsobject
patient_phone_numbersArray of objects or null(PhoneNumber)
post_codestring or null
preferred_first_namestring or null<= 255 characters
pronounsobject or null
receives_cancellation_emailsboolean or null
receives_confirmation_emailsboolean or null
referral_sourcestring or null<= 255 characters
referring_doctorobject
relationshipsobject
reminders_communication_channelsArray of integers

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
Items Enum12
Example: [1,2]
reminders_communication_channels_descriptionstring
Enum"None""SMS""Email""SMS & Email"
sexstring or null
statestring or null
time_zonestring or null
Example: "Australia/Melbourne"
titlestring or null<= 255 characters
updated_atstring(date-time)
countrystring or nullDeprecated
genderstring or nullDeprecated
reminder_typestring or nullDeprecated

Please use the reminders_communication_channels attribute instead.

Enum"None""SMS""Email""SMS & Email"
Response
application/json
{ "accepted_email_marketing": true, "accepted_privacy_policy": true, "accepted_sms_marketing": true, "address_1": "string", "address_2": "string", "address_3": "string", "appointment_notes": "string", "appointments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/appointments" } }, "archived_at": "2019-08-24T14:15:22Z", "attendees": { "links": { "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1" } }, "city": "string", "concession_type": { "links": { "self": "https://api.au1.cliniko.com/v1/concession_types/1" } }, "country": "string", "country_code": "AU", "created_at": "2019-08-24T14:15:22Z", "custom_fields": { "sections": [ { "name": "string", "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70", "archived": true, "fields": [] } ] }, "date_of_birth": "2019-08-24", "deleted_at": "2019-08-24T14:15:22Z", "dva_card_number": "string", "email": "string", "emergency_contact": "string", "first_name": "string", "follow_ups_communication_channels": [ 1, 2 ], "follow_ups_communication_channels_description": "None", "gender": "string", "gender_identity": "string", "id": "string", "invoice_default_to": "string", "invoice_email": "string", "invoice_extra_information": "string", "invoices": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/invoices" } }, "label": "string", "last_name": "string", "latest_booking": { "links": { "self": "https://api.au1.cliniko.com/v1/bookings/1" } }, "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" }, "medical_alerts": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts" } }, "medicare": "string", "medicare_reference_number": "string", "merged_at": "2019-08-24T14:15:22Z", "merged_with_patient": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1" } }, "notes": "string", "occupation": "string", "old_reference_id": "string", "patient_attachments": { "links": { "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments" } }, "patient_phone_numbers": [ { "normalized_number": "39012345678", "number": "0-123-456-78", "phone_type": "Fax" } ], "post_code": "string", "preferred_first_name": "string", "pronouns": { "accusative": "string", "nominative": "string", "predicative_possessive": "string", "pronominal_possessive": "string", "reflexive": "string" }, "receives_cancellation_emails": true, "receives_confirmation_emails": true, "referral_source": "string", "referring_doctor": { "links": { "self": "https://api.au1.cliniko.com/v1/contacts/1" } }, "relationships": { "links": { "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1" } }, "reminder_type": "None", "reminders_communication_channels": [ 1, 2 ], "reminders_communication_channels_description": "None", "sex": "string", "state": "string", "time_zone": "Australia/Melbourne", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }

Archive patientDeprecated

Request

Security
basicAuth
Path
idstring(int64)required
curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.au1.cliniko.com/v1/patients/{id}'

Responses

Resource was archived successfully

Patient Attachment

Schemas
Operations

Patient Case

Schemas
Operations

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 &lt;).

Content inside unescaped angle brackets could be identified as unsupported HTML and will be stripped.

Schemas
Operations

Patient Form Template

Schemas
Operations

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).

Schemas
Operations

Practitioner Reference Number

Schemas
Operations

Product

Schemas
Operations

Product Supplier

Schemas
Operations

Public Settings

Schemas
Operations

Referral Source

Referral source of a patient

Schemas
Operations

Referral Source Type

Types of referrals for patients

Schemas
Operations

Relationship

Schemas
Operations

Service

Schemas
Operations

Settings

Schemas
Operations

Signature

Schemas
Operations

Stock Adjustment

Schemas
Operations

Tax

Schemas
Operations

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 &lt;).

Content inside unescaped angle brackets could be identified as unsupported HTML and will be stripped.

Schemas
Operations

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 &lt;).

Content inside unescaped angle brackets could be identified as unsupported HTML and will be stripped.

Schemas
Operations

Unavailable Block

Schemas
Operations

Unavailable Block Type

Schemas
Operations

User

Schemas
Operations