List Dates

get

https://{api_url}/api/v5/{company_id}/dates

Get a list of available dates in which bookings can occur
The amount of times left available on each day are specified
If person_id and resource_id are not specified and the service has multiple people
or resources (as specified by the who/what/where config), it will count the times
for any given date

Recipes

📆

Service first customer appointment booking journey

Open Recipe

The amount of times left available on each day are specified. If person_id and resource_id are not specified and the service has multiple people or resources (as specified by the who/what/where config), it will count the times for any given date

Path Params

company_id

int32

required

Query Params

service_id

int32

required

person_id

int32

resource_id

int32

start_date

date

required

Start Date in ISO-8601 format: %Y-%m-%d

end_date

date

End Date in ISO-8601 format: %Y-%m-%d

time_zone

string

Show times in a different time zone than the company

only_available

boolean

Only show bookable start times

ignore_booking

int32

The ID of an existing booking to ignore - which will remove the associated slots from availability search

duration

int32

Desired duration of the appointment, in minutes

assets[company_rule]

array of strings

This asset must be on a company matching a rule. Valid values: 'default', 'any', Array

assets[company_rule]

assets[person_rule]

array of strings

This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array

assets[person_rule]

assets[resource_rule]

array of strings

This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array

assets[resource_rule]

assets[pre_time]

array of int32s

Pre Time. Overrides service configuration

assets[pre_time]

assets[post_time]

array of int32s

Post Time. Overrides service configuration

assets[post_time]

assets[person_group_id]

array of int32s

Person Group ID. This will overwrite the person_rule

assets[person_group_id]

assets[resource_group_id]

array of int32s

Resource Group ID. This will overwrite the resource_rule

assets[resource_group_id]

Responses

400

Bad Request

404

Not Found

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Date Collection