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.

AvailableTime

appointment_start
string <date-time>
{
  • "appointment_start": "2019-08-24T14:15:22Z"
}

Get all available times

get/businesses/{business_id}/practitioners/{practitioner_id}/appointment_types/{appointment_type_id}/available_times

Find appointment start times that are currently available for the practitioner based on parameters provided.

SecuritybasicAuth
Request
path Parameters
appointment_type_id
required
string <int64>
Example: 1
business_id
required
string <int64>
Example: 1
practitioner_id
required
string <int64>
Example: 1
query Parameters
from
required
string <date>

Cannot be more than 7 days before to. Cannot be older than the current date in the account's time zone.

page
integer
per_page
integer [ 1 .. 100 ]
to
required
string <date>

Cannot be more than 7 days after from. Cannot be older than the current date in the account's time zone.

Responses
200

successful operation

Request samples 
Response samples 
Get next available time
get/businesses/{business_id}/practitioners/{practitioner_id}/appointment_types/{appointment_type_id}/next_available_time
SecuritybasicAuth 
Request 
path Parameters
appointment_type_id
required
string <int64> 
 
 Example:  1
business_id
required
string <int64> 
 
 Example:  1
practitioner_id
required
string <int64> 
 
 Example:  1
query Parameters
from
required
string <date> 
Cannot be more than 7 days before to. Cannot be older than the current date in the account's time zone.


 
to
required
string <date> 
Cannot be more than 7 days after from. Cannot be older than the current date in the account's time zone.


 
Responses 
200
successful operation


Request samples 
Response samples 
application/json
{}