Daily Availability

The regularly scheduled availabilities of a practitioner at a business

DailyAvailability

	Array of objects or null
	object
created_at	string <date-time>
day_of_week	integer or null Enum: 0 1 2 3 4 5 6
id	string <int64>
	object
	object
time_zone	string or null See: supported time zones
time_zone_identifier	string or null See: supported time zone identifiers
updated_at	string <date-time>

{"availabilities": [{"starts_at": "09:00",
"ends_at": "13:00"
}
],
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"day_of_week": 0,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities/1"
},
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"time_zone": "Melbourne",
"time_zone_identifier": "Australia/Melbourne",
"updated_at": "2019-08-24T14:15:22Z"
}

List daily availabilities

get/daily_availabilities

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
id	int64
created_at	date-time
updated_at	date-time
business_id	int64
practitioner_id	int64

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

{"daily_availabilities": [{"availabilities": [{"starts_at": "09:00",
"ends_at": "13:00"
}
],
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"day_of_week": 0,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities/1"
},
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"time_zone": "Melbourne",
"time_zone_identifier": "Australia/Melbourne",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities?page=2",
"previous": "https://api.au1.cliniko.com/v1/daily_availabilities?page=1",
"next": "https://api.au1.cliniko.com/v1/daily_availabilities?page=3"
}
}

Get daily availability

get/daily_availabilities/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"availabilities": [{"starts_at": "09:00",
"ends_at": "13:00"
}
],
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"day_of_week": 0,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities/1"
},
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"time_zone": "Melbourne",
"time_zone_identifier": "Australia/Melbourne",
"updated_at": "2019-08-24T14:15:22Z"
}

List daily availabilities for business

get/businesses/{business_id}/daily_availabilities

SecuritybasicAuth

Request

path Parameters

business_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
id	int64
created_at	date-time
updated_at	date-time
practitioner_id	int64

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

{"daily_availabilities": [{"availabilities": [{"starts_at": "09:00",
"ends_at": "13:00"
}
],
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"day_of_week": 0,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities/1"
},
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"time_zone": "Melbourne",
"time_zone_identifier": "Australia/Melbourne",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1/daily_availabilities?page=2",
"previous": "https://api.au1.cliniko.com/v1/businesses/1/daily_availabilities?page=1",
"next": "https://api.au1.cliniko.com/v1/businesses/1/daily_availabilities?page=3"
}
}

List daily availabilities for practitioner

get/practitioners/{practitioner_id}/daily_availabilities

SecuritybasicAuth

Request

path Parameters

practitioner_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
id	int64
created_at	date-time
updated_at	date-time
business_id	int64

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

{"daily_availabilities": [{"availabilities": [{"starts_at": "09:00",
"ends_at": "13:00"
}
],
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"day_of_week": 0,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/daily_availabilities/1"
},
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"time_zone": "Melbourne",
"time_zone_identifier": "Australia/Melbourne",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/daily_availabilities?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners/1/daily_availabilities?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners/1/daily_availabilities?page=3"
}
}