Retrieve Appointment Slots

get

https://example.com/appointment_slots

Returns a list of Appointment Slots applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

appointment_type

integer

Filter via Appointment Type by ID. Will return all appointment slots belonging to the specified appointment type.

date

string

Filter via Date. Will return all appointment slots configured for this date. Accepts YYYY-MM-DD format.

day

string

Filter via Day. Will return all appointment slots recurring on a specific day ( eg. "monday" ). Accepts day fullname - eg. day=monday. Do not use shortnames like "mon" or "tues".

week

integer

Filter via week of the month. Will return all appointment slots recurring on a specific week of the month. Accepts week count - eg. week=2 for the second week of the month.

capacity_gte

string

Filter via capacity. Will return all appointment slots with a capacity greater than the provided value.

capacity_lte

string

Filter via capacity. Will return all appointment slots with a capacity less than the provided value.

start_time_before

string

Filter via start_time_before. Will return all appointment slots with start times before the supplied time. Accepts 2400 hour HH:MM:SS format - eg. 14:00:00 for 2PM.

start_time_after

string

Filter via start_time_after. Will return all appointment slots with start times after the supplied time. Accepts 2400 hour HH:MM:SS format - eg. 14:00:00 for 2PM.

end_time_before

string

Filter via end_time_before. Will return all appointment slots with end times before the supplied time. Accepts 2400 hour HH:MM:SS format - eg. 14:00:00 for 2PM.

end_time_after

string

Filter via end_time_after. Will return all appointment slots with end times after the supplied time. Accepts 2400 hour HH:MM:SS format - eg. 14:00:00 for 2PM.

Response

Language

Loading…

Response

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

application/json

200search results matching criteria