Booking

Any of:

	object
archived_at	string or null <date-time>
	object
	object
	object or null
created_at	string <date-time>
deleted_at	string or null <date-time>
ends_at	string <date-time>
id	string <int64>
	object
max_attendees	integer ( 1 .. 100 )
notes	string or null
patient_ids	Array of strings or null <int64>
	object
	object or null
	object
	object or null
starts_at	string <date-time>
telehealth_url	string or null <uri>
updated_at	string <date-time>

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees"
}
},
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"conflicts": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/conflicts"
}
},
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
},
"max_attendees": 2,
"notes": "string",
"patient_ids": ["1"
],
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"repeat_rule": {"number_of_repeats": 0,
"repeat_type": "Daily",
"repeating_interval": 0
},
"repeated_from": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
}
},
"repeats": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments?q[]=repeated_from_id:=1"
}
},
"starts_at": "2019-08-24T14:15:22Z",
"telehealth_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z"
}

List bookings

get/bookings

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_type_id	int64
archived_at	date-time
business_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
did_not_arrive	boolean
email_reminder_sent	boolean
ends_at	date-time
id	int64
invoice_status	integer
patient_ids	array
practitioner_id	int64
repeated_from_id	int64
sms_reminder_sent	boolean
starts_at	date-time
treatment_note_status	integer
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

{"bookings": [{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees"
}
},
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"conflicts": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/conflicts"
}
},
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
},
"max_attendees": 2,
"notes": "string",
"patient_ids": ["1"
],
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"repeat_rule": {"number_of_repeats": 0,
"repeat_type": "Daily",
"repeating_interval": 0
},
"repeated_from": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
}
},
"repeats": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments?q[]=repeated_from_id:=1"
}
},
"starts_at": "2019-08-24T14:15:22Z",
"telehealth_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/bookings?page=2",
"previous": "https://api.au1.cliniko.com/v1/bookings?page=1",
"next": "https://api.au1.cliniko.com/v1/bookings?page=3"
}
}

Get booking

get/bookings/{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

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees"
}
},
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"conflicts": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/conflicts"
}
},
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
},
"max_attendees": 2,
"notes": "string",
"patient_ids": ["1"
],
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"repeat_rule": {"number_of_repeats": 0,
"repeat_type": "Daily",
"repeating_interval": 0
},
"repeated_from": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
}
},
"repeats": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments?q[]=repeated_from_id:=1"
}
},
"starts_at": "2019-08-24T14:15:22Z",
"telehealth_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z"
}

List bookings for patient caseDeprecated

get/patient_cases/{patient_case_id}/bookings

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_type_id	int64
archived_at	date-time
business_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
did_not_arrive	boolean
email_reminder_sent	boolean
ends_at	date-time
id	int64
invoice_status	integer
patient_ids	array
practitioner_id	int64
repeated_from_id	int64
sms_reminder_sent	boolean
starts_at	date-time
treatment_note_status	integer
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

{"bookings": [{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"attendees": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees"
}
},
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"conflicts": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1/conflicts"
}
},
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
},
"max_attendees": 2,
"notes": "string",
"patient_ids": ["1"
],
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"repeat_rule": {"number_of_repeats": 0,
"repeat_type": "Daily",
"repeating_interval": 0
},
"repeated_from": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments/1"
}
},
"repeats": {"links": {"self": "https://api.au1.cliniko.com/v1/group_appointments?q[]=repeated_from_id:=1"
}
},
"starts_at": "2019-08-24T14:15:22Z",
"telehealth_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/bookings?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_cases/1/bookings?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_cases/1/bookings?page=3"
}
}