View availabilities
GET {{baseUrl}}/availabilities?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=5&include[]=<string>&include[]=<string>&provider_id=<integer>&operatory_id=<integer>&active=true&ignore_past_dates=false
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified location | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 300 per page | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response | |
provider_id | string | Filter for specific provider | |
operatory_id | string | Filter for specific operatory | |
active | boolean | Filter active/not active | |
ignore_past_dates | boolean | Filter out availabilities configured for specific dates in the past |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","operatory_id":"\u003cinteger\u003e","begin_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","appointment_types":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"}],"days":["\u003cstring\u003e","\u003cstring\u003e"],"specific_date":"\u003cdate\u003e","custom_recurrence":"\u003cobject\u003e","active":"\u003cboolean\u003e","synced":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","operatory_id":"\u003cinteger\u003e","begin_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","appointment_types":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"}],"days":["\u003cstring\u003e","\u003cstring\u003e"],"specific_date":"\u003cdate\u003e","custom_recurrence":"\u003cobject\u003e","active":"\u003cboolean\u003e","synced":"\u003cboolean\u003e"}],"count":"\u003cinteger\u003e"}