Qodex.ai

View appointment slots

GET {{baseUrl}}/appointment_slots?subdomain={{subdomain}}&start_date=2024-04-16&days=5&lids[]=109441&pids[]=223773180&appointment_type_id=220895

Request Params

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution
start_datestring(Required) Date string you want results to start at, format YYYY-MM-DD
daysnumber(Required) Number of days to include, counting the start date
lids[]number(Required) Array of Location Ids
lids[]null(Required) Array of Location Ids
pids[]number(Required) Array of Provider Ids
pids[]string(Required) Array of Provider Ids
operatory_ids[]stringSpecify this if booking is mapped to operatory in this location
operatory_ids[]stringSpecify this if booking is mapped to operatory in this location
appointment_type_idnumberSpecify an appointment type to filter returned slots and set slot_length to appointment_type.minutes
slot_lengthstringManually specify slot length in minutes. Defaults to 15 minutes
slot_intervalstringManually specify the time in minutes between returned slot start times when a contiguous opening exists longer than the slot_length

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

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"}],"next_available_date":"\u003cdate\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"}],"next_available_date":"\u003cdate\u003e"}],"count":"\u003cinteger\u003e"}