get Appointment Slots
GET {{baseUrl}}/appointment_slots?subdomain={{subdomain}}&start_date=<date>&days=<integer>&lids[]=<integer>&lids[]=<integer>&pids[]=<integer>&pids[]=<integer>&operatory_ids[]=<integer>&operatory_ids[]=<integer>&appointment_type_id=<integer>&slot_length=<integer>&slot_interval=<integer>
Get a list of open slots during which the specified provider is available
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
start_date | string | (Required) Date string you want results to start at, format YYYY-MM-DD | |
days | string | (Required) Number of days to include, counting the start date | |
lids[] | string | (Required) Array of Location Ids | |
lids[] | string | (Required) Array of Location Ids | |
pids[] | string | (Required) Array of Provider Ids | |
pids[] | string | (Required) Array of Provider Ids | |
operatory_ids[] | string | Specify this if booking is mapped to operatory in this location | |
operatory_ids[] | string | Specify this if booking is mapped to operatory in this location | |
appointment_type_id | string | Specify an appointment type to filter returned slots and set slot_length to appointment_type.minutes | |
slot_length | string | Manually specify slot length in minutes. Defaults to 15 minutes | |
slot_interval | string | Manually specify the time in minutes between returned slot start times when a contiguous opening exists longer than the slot_length |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"lid":"\u003cinteger\u003e","pid":"\u003cinteger\u003e","operatory_id":"\u003cinteger\u003e","slots":[{"time":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e"},{"time":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e"}]},{"lid":"\u003cinteger\u003e","pid":"\u003cinteger\u003e","operatory_id":"\u003cinteger\u003e","slots":[{"time":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e"},{"time":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e"}]}],"count":"\u003cinteger\u003e"}