Attendee

archived_at

string or null <date-time>

arrived

boolean or null

object

booking_ip_address

string or null <ipv4>

cancellation_note

string or null

cancellation_reason

integer or null

cancellation_reason_description

string or null

Enum: "Feeling Better" "Condition Worse" "Sick" "COVID-19 related" "Away" "Other" "Work" ""

cancellation_url

string or null <uri>

cancelled_at

string or null <date-time>

created_at

string <date-time>

deleted_at

string or null <date-time>

email_reminder_sent

boolean or null

string <int64>

invoice_status

integer or null

Enum Value	Description
10	Open
20	Paid
30	Closed
40	Open credit

Enum: 10 20 30 40

object

notes

string or null

online_booking_policy_accepted

boolean or null

object

sent_email_reminders_count

integer or null

sent_sms_reminders_count

integer or null

sms_reminder_sent

boolean or null

telehealth_url

string or null <uri>

treatment_note_status

integer or null

Enum Value	Description
10	Draft
90	Final

Enum: 10 90

updated_at

string <date-time>

{"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"
}

List attendees

get/attendees

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
booking_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
id	int64
patient_case_id	int64
patient_id	int64
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"attendees": [{"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"
}
],
"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"
}
}

Create attendee

post/attendees

SecuritybasicAuth

Request

Request Body schema: application/json

arrived	boolean or null
booking_id	string <int64> booking id
notes	string or null
patient_case_id	string <int64> patient case id
patient_id	string <int64> patient id

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"booking_id": "1",
"arrived": true,
"notes": "string",
"patient_id": "1",
"patient_case_id": "1"
}

Response samples

application/json

{"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"
}

Get attendee

get/attendees/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
cancelled_at	date-time
deleted_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"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"
}

Update attendee

patch/attendees/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

arrived	boolean or null
notes	string or null
patient_case_id	string <int64> patient case id

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"arrived": true,
"notes": "string",
"patient_case_id": "1"
}

Response samples

application/json

{"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"
}

Archive attendeeDeprecated

delete/attendees/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived successfully

Request samples

curl
JavaScript
Python
Ruby

Archive attendee

post/attendees/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby

Cancel attendee

patch/attendees/{id}/cancel

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

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

apply_to_repeats

boolean

cancellation_note

string or null

cancellation_reason

integer

Enum Value	Description
10	Feeling better
20	Condition worse
30	Sick
40	Away
50	Other
60	Work

Enum: 10 20 30 40 50 60

Responses

204

Resource was cancelled

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"cancellation_note": "string",
"cancellation_reason": 10,
"apply_to_repeats": true
}

List attendees for group appointmentDeprecated

get/group_appointments/{group_appointment_id}/attendees

SecuritybasicAuth

Request

path Parameters

group_appointment_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
booking_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
id	int64
patient_case_id	int64
patient_id	int64
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"attendees": [{"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"
}
],
"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"
}
}

List attendees for individual appointmentDeprecated

get/individual_appointments/{individual_appointment_id}/attendees

SecuritybasicAuth

Request

path Parameters

individual_appointment_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
booking_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
id	int64
patient_case_id	int64
patient_id	int64
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"attendees": [{"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"
}
],
"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"
}
}

List attendees for patient caseDeprecated

get/patient_cases/{patient_case_id}/attendees

SecuritybasicAuth

Request

path Parameters

patient_case_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
booking_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
id	int64
patient_id	int64
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"attendees": [{"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"
}
],
"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"
}
}