get 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

Get a list of availabilities

Request Params

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution
location_idstring(Required) Used to scope the request to the specified institution
pagenumberPage number. Starts with page 1
per_pagenumberNumber of results to return per page. Defaults is 5 per page and Max 100 per page
include[]stringResources to be included in the response
include[]stringResources to be included in the response
provider_idstringFilter for specific provider
operatory_idstringFilter for specific operatory
activebooleanFilter active/not active
ignore_past_datesbooleanFilter out availabilities configured for specific dates in the past

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cboolean\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;error&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;operatory_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;begin_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;appointment_types&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;,&quot;bookable_online&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;,&quot;bookable_online&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;days&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;specific_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;custom_recurrence&quot;:&quot;\u003cobject\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;synced&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;operatory_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;begin_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;appointment_types&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;,&quot;bookable_online&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;,&quot;bookable_online&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;days&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;specific_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;custom_recurrence&quot;:&quot;\u003cobject\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;synced&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}