Skip to content

Get Available Slots

GET
/appointments/slots

The bookable times for an event type, grouped by date under slots.

The AUTHENTICATED slots read - the unauthenticated one a prospect’s browser calls is deliberately not published (see the module docstring).

Authorizations

Parameters

Query Parameters

event_type_id
required

Event type to compute slots for.

integer

Event type to compute slots for.

start
required

Window start, ISO-8601. A bare date is read as UTC.

string

Window start, ISO-8601. A bare date is read as UTC.

end
required

Window end, ISO-8601. At most 60 days after start.

string

Window end, ISO-8601. At most 60 days after start.

time_zone
Any of:
string

IANA timezone to express the slots in.

duration
Any of:
integer

Minutes, for a multi-duration event type. Omit for its own length.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a filter, a setting, an embed config or a slot grid.

Open because org settings gain branding fields as the booking page does and the embed config gains styling keys as the widget does. Closing it would drop a field the app had already started returning.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string