get Locations
GET {{baseUrl}}/locations?subdomain={{subdomain}}&inactive=<boolean>&foreign_id=<string>
Get a list of locations
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | Used to scope the request to the specified institution | |
inactive | string | Filter by inactive status | |
foreign_id | string | Find location by the integrated system Id |
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","name":"\u003cstring\u003e","subdomain":"\u003cstring\u003e","locations":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","street_address":"\u003cstring\u003e","street_address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","email":"\u003cstring\u003e","tz":"\u003cstring\u003e","last_sync_time":"\u003cstring\u003e","insert_appt_client":"\u003cboolean\u003e","map_by_operatory":"\u003cboolean\u003e","set_availability_by_operatory":"\u003cboolean\u003e","inactive":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","street_address":"\u003cstring\u003e","street_address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","email":"\u003cstring\u003e","tz":"\u003cstring\u003e","last_sync_time":"\u003cstring\u003e","insert_appt_client":"\u003cboolean\u003e","map_by_operatory":"\u003cboolean\u003e","set_availability_by_operatory":"\u003cboolean\u003e","inactive":"\u003cboolean\u003e"}]},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","subdomain":"\u003cstring\u003e","locations":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","street_address":"\u003cstring\u003e","street_address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","email":"\u003cstring\u003e","tz":"\u003cstring\u003e","last_sync_time":"\u003cstring\u003e","insert_appt_client":"\u003cboolean\u003e","map_by_operatory":"\u003cboolean\u003e","set_availability_by_operatory":"\u003cboolean\u003e","inactive":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","street_address":"\u003cstring\u003e","street_address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","email":"\u003cstring\u003e","tz":"\u003cstring\u003e","last_sync_time":"\u003cstring\u003e","insert_appt_client":"\u003cboolean\u003e","map_by_operatory":"\u003cboolean\u003e","set_availability_by_operatory":"\u003cboolean\u003e","inactive":"\u003cboolean\u003e"}]}],"count":"\u003cinteger\u003e"}