List Times

Get a list of available booking start times for a particular day.
The available durations and prices are included under each start time.
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), times that are the same but differ by
person or resource are merged together by default. If booking a particular person or
resource either pass in their IDs in the person_id and resource_id params or pass the
merge_times param as false.
Requested Assets (requested_assets), this parameters describe a list of rules which a time must
satisfy to be considered available.
A Requested asset consists of a

  • company_rule -> can be either default (it will respect the company of the URL), any (it can be any company that provides the service), or Array<CompanyID> one of these companies (which must provide the service).
  • person_rule -> can be either any (any person which provides the service), any_or_none (the user is indifferent as to whether a person is associated to the booking), Array<PersonID> one of these people who provide the service.
  • resource_rule -> same as person_rule: can be either any (any resource which provides the service), any_or_none (the user is indifferent as to whether a resource is associated to the booking), Array<PersonID> one of these resources with which the service can be provided.
    Factors that influence availability include:
  • Service, Person and Resource schedules
  • Bookings and blocked time
  • Company opening hours
  • Max/min advance
  • Min/max consecutive bookings (fixed time service)
  • Durations (flex time service)
  • Travel time (flex time service)
  • Booking time step
Recipes
🕰️
Fetch Available Appointment Times
Open Recipe
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Query Params
int32
required
int32
int32
date
required
date
json

Show times in a different time zone than the company

boolean

Only show bookable start times

int32
int32

Desired duration of the appointment, in minutes

int32

Pre Time. Overrides service configuration

int32

Post Time. Overrides service configuration

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]
Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json