get Providers

GET {{baseUrl}}/providers?subdomain={{subdomain}}&page=1&per_page=5&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

KeyDatatypeRequiredDescription
subdomainstring(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
location_idstringOnly return providers associated with the specified Location Id
foreign_idstringUnique appointment id from the EMR
requestablestringOnly return providers who are requestable at the specified location_id
inactivestringFilter result set based on inactive status, defaults to false if not specified
updated_sincestringQuery 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

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;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;middle_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;bio&quot;:&quot;\u003cobject\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;npi&quot;:&quot;\u003cstring\u003e&quot;,&quot;locations&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;street_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;street_address_2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;longitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;insert_appt_client&quot;:&quot;\u003cboolean\u003e&quot;,&quot;map_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;set_availability_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;street_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;street_address_2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;longitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;insert_appt_client&quot;:&quot;\u003cboolean\u003e&quot;,&quot;map_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;set_availability_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;provider_requestables&quot;:[{&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;}]},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;middle_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;bio&quot;:&quot;\u003cobject\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;npi&quot;:&quot;\u003cstring\u003e&quot;,&quot;locations&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;street_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;street_address_2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;longitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;insert_appt_client&quot;:&quot;\u003cboolean\u003e&quot;,&quot;map_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;set_availability_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;street_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;street_address_2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;zip_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;longitude&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;insert_appt_client&quot;:&quot;\u003cboolean\u003e&quot;,&quot;map_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;set_availability_by_operatory&quot;:&quot;\u003cboolean\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;provider_requestables&quot;:[{&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;}]}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}