get Providers
GET {{baseUrl}}/providers?subdomain={{subdomain}}&page=1&per_page=20&include[]=["locations","provider_requestables"]&include[]=["locations","provider_requestables"]&location_id={{location_id}}&foreign_id=<string>&requestable=<boolean>&inactive=<boolean>&updated_since=<dateTime>
Get a list of providers
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
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 100 per page | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response | |
location_id | string | Only return providers associated with the specified Location Id | |
foreign_id | string | Unique appointment id from the EMR | |
requestable | string | Only return providers who are requestable at the specified location_id | |
inactive | string | Filter result set based on inactive status, defaults to false if not specified | |
updated_since | string | Query providers whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000 |
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","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\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"}],"provider_requestables":[{"location_id":"\u003cinteger\u003e"},{"location_id":"\u003cinteger\u003e"}]},{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\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"}],"provider_requestables":[{"location_id":"\u003cinteger\u003e"},{"location_id":"\u003cinteger\u003e"}]}],"count":"\u003cinteger\u003e"}