GET api/Doctors?specialtyID={specialtyID}&locationID={locationID}&gender={gender}&onlineAppts={onlineAppts}&virtualClinic={virtualClinic}

Get doctors with filter/search parameters

Request Information

URI Parameters

NameDescriptionTypeAdditional information
specialtyID

Use 0 for all specialties

integer

Required

locationID

Use 0 for all locations

integer

Required

gender

'Male', 'Female' or empty string for all

string

Required

onlineAppts

'yes', 'no' or empty string for all

string

Required

virtualClinic

'yes', 'no' or empty string for all

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of Doctor
NameDescriptionTypeAdditional information
ID

integer

None.

FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

Title

string

None.

Phone

string

None.

Image

string

None.

ClinicalInterests

string

None.

ClinicalDoctorate

string

None.

ResidencyTraining

string

None.

Fellowship

string

None.

BoardCert

string

None.

Certifications

string

None.

MedicalDegree

string

None.

About

string

None.

Active

boolean

None.

GraduateDegree

string

None.

Internship

string

None.

UndergradDegree

string

None.

VideoID

integer

None.

ThumbUrl

string

None.

Gender

string

None.

AppointmentUrl

string

None.

MedicalSocieties

string

None.

URL

string

None.

Fullname

string

None.

FullnameLastFirst

string

None.

PageUrl

string

None.

PrimaryLocationID

integer

None.

PrimaryLocation

Location

None.

Specialties

Collection of Specialty

None.

Video

Video

None.

OfficePhone

string

None.

MobilePhone

string

None.

Pager

string

None.

PreferredContact

string

None.

AcceptNewPatients

string

None.

OnCallProviderCode

string

None.

CustomSpecialty

string

None.

HoursOther

string

None.

ProviderType

integer

None.

OnCallDetails

string

None.

OnCallEventOther1

string

None.

OnCallSpecialty

string

None.

VirtualClinic

boolean

None.

VirtualClinicApptUrl

string

None.

TICProvider

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Title": "sample string 5",
    "Phone": "sample string 6",
    "Image": "sample string 7",
    "ClinicalInterests": "sample string 8",
    "ClinicalDoctorate": "sample string 9",
    "ResidencyTraining": "sample string 10",
    "Fellowship": "sample string 11",
    "BoardCert": "sample string 12",
    "Certifications": "sample string 13",
    "MedicalDegree": "sample string 14",
    "About": "sample string 15",
    "Active": true,
    "GraduateDegree": "sample string 17",
    "Internship": "sample string 18",
    "UndergradDegree": "sample string 19",
    "VideoID": 20,
    "ThumbUrl": "sample string 21",
    "Gender": "sample string 22",
    "AppointmentUrl": "sample string 23",
    "MedicalSocieties": "sample string 24",
    "URL": "sample string 25",
    "Fullname": "sample string 2 sample string 3 sample string 4",
    "FullnameLastFirst": "sample string 4, sample string 2",
    "PageUrl": "https://www.iowaclinic.com/doctors/d1/sample-string-2-sample-string-3-sample-string-4/",
    "PrimaryLocationID": 26,
    "PrimaryLocation": {
      "ID": 26,
      "Name": "Adair County Hospital",
      "Address1": "609 SE Kent",
      "Address2": "",
      "City": "Greenfield",
      "State": "IA",
      "Zip": "50849",
      "Email": "",
      "URL": "locations/adair-county-hospital",
      "SortOrder": 0,
      "Active": true,
      "Latitude": 0.0,
      "Longitude": 0.0,
      "Image": null,
      "AlternateText": "",
      "SEOTitle": "",
      "SEODescription": "",
      "Content": "",
      "URLToLocationDetail": "https://www.iowaclinic.com/locations/locations/adair-county-hospital/",
      "PhoneNumbers": [
        {
          "PhoneNumber": "",
          "PhoneType": "Primary"
        }
      ],
      "LocationLongName": "Adair County Hospital - 609 SE Kent, Greenfield",
      "HeaderImage": null,
      "ThumbImage": "https://www.iowaclinic.com/Content/cms/images/locations/Primary%20Locations/_location-no-image-th.png",
      "OutreachLocation": true,
      "DisplayMain": false,
      "MapUrl": "https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d2997.238610340161!2d-94.4540279838203!3d41.303672509142416!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x87ec86efae0484c9%3A0x73f9cf8b9d975221!2sAdair+County+Health+System!5e0!3m2!1sen!2sus!4v1502805221491",
      "DirectionsUrl": "https://www.google.com/maps?saddr=Current+Location&daddr=609+SE+Kent+Greenfield+IA+50849",
      "MainLocationID": 0,
      "PrimaryPhone": "",
      "ShowDoctors": true,
      "HidePhoneNumbers": false,
      "CareOption": "Primary Care",
      "Specialties": []
    },
    "Specialties": [],
    "Video": {
      "ID": 20,
      "Title": "Eric Scott, MD",
      "VideoUrl": "https://youtu.be/KDnf2bpsxZ4",
      "ThumbUrl": "https://www.iowaclinic.com/webres/Image/doctor-video/EricScott.png",
      "Description": ""
    },
    "OfficePhone": "sample string 27",
    "MobilePhone": "sample string 28",
    "Pager": "sample string 29",
    "PreferredContact": "sample string 30",
    "AcceptNewPatients": "sample string 31",
    "OnCallProviderCode": "sample string 32",
    "CustomSpecialty": "sample string 33",
    "HoursOther": "sample string 34",
    "ProviderType": 35,
    "OnCallDetails": "sample string 36",
    "OnCallEventOther1": "sample string 37",
    "OnCallSpecialty": "sample string 38",
    "VirtualClinic": true,
    "VirtualClinicApptUrl": "sample string 40",
    "TICProvider": true
  },
  {
    "ID": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Title": "sample string 5",
    "Phone": "sample string 6",
    "Image": "sample string 7",
    "ClinicalInterests": "sample string 8",
    "ClinicalDoctorate": "sample string 9",
    "ResidencyTraining": "sample string 10",
    "Fellowship": "sample string 11",
    "BoardCert": "sample string 12",
    "Certifications": "sample string 13",
    "MedicalDegree": "sample string 14",
    "About": "sample string 15",
    "Active": true,
    "GraduateDegree": "sample string 17",
    "Internship": "sample string 18",
    "UndergradDegree": "sample string 19",
    "VideoID": 20,
    "ThumbUrl": "sample string 21",
    "Gender": "sample string 22",
    "AppointmentUrl": "sample string 23",
    "MedicalSocieties": "sample string 24",
    "URL": "sample string 25",
    "Fullname": "sample string 2 sample string 3 sample string 4",
    "FullnameLastFirst": "sample string 4, sample string 2",
    "PageUrl": "https://www.iowaclinic.com/doctors/d1/sample-string-2-sample-string-3-sample-string-4/",
    "PrimaryLocationID": 26,
    "PrimaryLocation": {
      "ID": 26,
      "Name": "Adair County Hospital",
      "Address1": "609 SE Kent",
      "Address2": "",
      "City": "Greenfield",
      "State": "IA",
      "Zip": "50849",
      "Email": "",
      "URL": "locations/adair-county-hospital",
      "SortOrder": 0,
      "Active": true,
      "Latitude": 0.0,
      "Longitude": 0.0,
      "Image": null,
      "AlternateText": "",
      "SEOTitle": "",
      "SEODescription": "",
      "Content": "",
      "URLToLocationDetail": "https://www.iowaclinic.com/locations/locations/adair-county-hospital/",
      "PhoneNumbers": [
        {
          "PhoneNumber": "",
          "PhoneType": "Primary"
        }
      ],
      "LocationLongName": "Adair County Hospital - 609 SE Kent, Greenfield",
      "HeaderImage": null,
      "ThumbImage": "https://www.iowaclinic.com/Content/cms/images/locations/Primary%20Locations/_location-no-image-th.png",
      "OutreachLocation": true,
      "DisplayMain": false,
      "MapUrl": "https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d2997.238610340161!2d-94.4540279838203!3d41.303672509142416!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x87ec86efae0484c9%3A0x73f9cf8b9d975221!2sAdair+County+Health+System!5e0!3m2!1sen!2sus!4v1502805221491",
      "DirectionsUrl": "https://www.google.com/maps?saddr=Current+Location&daddr=609+SE+Kent+Greenfield+IA+50849",
      "MainLocationID": 0,
      "PrimaryPhone": "",
      "ShowDoctors": true,
      "HidePhoneNumbers": false,
      "CareOption": "Primary Care",
      "Specialties": []
    },
    "Specialties": [],
    "Video": {
      "ID": 20,
      "Title": "Eric Scott, MD",
      "VideoUrl": "https://youtu.be/KDnf2bpsxZ4",
      "ThumbUrl": "https://www.iowaclinic.com/webres/Image/doctor-video/EricScott.png",
      "Description": ""
    },
    "OfficePhone": "sample string 27",
    "MobilePhone": "sample string 28",
    "Pager": "sample string 29",
    "PreferredContact": "sample string 30",
    "AcceptNewPatients": "sample string 31",
    "OnCallProviderCode": "sample string 32",
    "CustomSpecialty": "sample string 33",
    "HoursOther": "sample string 34",
    "ProviderType": 35,
    "OnCallDetails": "sample string 36",
    "OnCallEventOther1": "sample string 37",
    "OnCallSpecialty": "sample string 38",
    "VirtualClinic": true,
    "VirtualClinicApptUrl": "sample string 40",
    "TICProvider": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfDoctor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iowaclinic_api.API">
  <Doctor>
    <About>sample string 15</About>
    <AcceptNewPatients>sample string 31</AcceptNewPatients>
    <Active>true</Active>
    <AppointmentUrl>sample string 23</AppointmentUrl>
    <BoardCert>sample string 12</BoardCert>
    <Certifications>sample string 13</Certifications>
    <ClinicalDoctorate>sample string 9</ClinicalDoctorate>
    <ClinicalInterests>sample string 8</ClinicalInterests>
    <CustomSpecialty>sample string 33</CustomSpecialty>
    <Fellowship>sample string 11</Fellowship>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 22</Gender>
    <GraduateDegree>sample string 17</GraduateDegree>
    <HoursOther>sample string 34</HoursOther>
    <ID>1</ID>
    <Image>sample string 7</Image>
    <Internship>sample string 18</Internship>
    <LastName>sample string 4</LastName>
    <MedicalDegree>sample string 14</MedicalDegree>
    <MedicalSocieties>sample string 24</MedicalSocieties>
    <MiddleName>sample string 3</MiddleName>
    <MobilePhone>sample string 28</MobilePhone>
    <OfficePhone>sample string 27</OfficePhone>
    <OnCallDetails>sample string 36</OnCallDetails>
    <OnCallEventOther1>sample string 37</OnCallEventOther1>
    <OnCallProviderCode>sample string 32</OnCallProviderCode>
    <OnCallSpecialty>sample string 38</OnCallSpecialty>
    <Pager>sample string 29</Pager>
    <Phone>sample string 6</Phone>
    <PreferredContact>sample string 30</PreferredContact>
    <PrimaryLocationID>26</PrimaryLocationID>
    <ProviderType>35</ProviderType>
    <ResidencyTraining>sample string 10</ResidencyTraining>
    <Specialties />
    <TICProvider>true</TICProvider>
    <ThumbUrl>sample string 21</ThumbUrl>
    <Title>sample string 5</Title>
    <URL>sample string 25</URL>
    <UndergradDegree>sample string 19</UndergradDegree>
    <VideoID>20</VideoID>
    <VirtualClinic>true</VirtualClinic>
    <VirtualClinicApptUrl>sample string 40</VirtualClinicApptUrl>
  </Doctor>
  <Doctor>
    <About>sample string 15</About>
    <AcceptNewPatients>sample string 31</AcceptNewPatients>
    <Active>true</Active>
    <AppointmentUrl>sample string 23</AppointmentUrl>
    <BoardCert>sample string 12</BoardCert>
    <Certifications>sample string 13</Certifications>
    <ClinicalDoctorate>sample string 9</ClinicalDoctorate>
    <ClinicalInterests>sample string 8</ClinicalInterests>
    <CustomSpecialty>sample string 33</CustomSpecialty>
    <Fellowship>sample string 11</Fellowship>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 22</Gender>
    <GraduateDegree>sample string 17</GraduateDegree>
    <HoursOther>sample string 34</HoursOther>
    <ID>1</ID>
    <Image>sample string 7</Image>
    <Internship>sample string 18</Internship>
    <LastName>sample string 4</LastName>
    <MedicalDegree>sample string 14</MedicalDegree>
    <MedicalSocieties>sample string 24</MedicalSocieties>
    <MiddleName>sample string 3</MiddleName>
    <MobilePhone>sample string 28</MobilePhone>
    <OfficePhone>sample string 27</OfficePhone>
    <OnCallDetails>sample string 36</OnCallDetails>
    <OnCallEventOther1>sample string 37</OnCallEventOther1>
    <OnCallProviderCode>sample string 32</OnCallProviderCode>
    <OnCallSpecialty>sample string 38</OnCallSpecialty>
    <Pager>sample string 29</Pager>
    <Phone>sample string 6</Phone>
    <PreferredContact>sample string 30</PreferredContact>
    <PrimaryLocationID>26</PrimaryLocationID>
    <ProviderType>35</ProviderType>
    <ResidencyTraining>sample string 10</ResidencyTraining>
    <Specialties />
    <TICProvider>true</TICProvider>
    <ThumbUrl>sample string 21</ThumbUrl>
    <Title>sample string 5</Title>
    <URL>sample string 25</URL>
    <UndergradDegree>sample string 19</UndergradDegree>
    <VideoID>20</VideoID>
    <VirtualClinic>true</VirtualClinic>
    <VirtualClinicApptUrl>sample string 40</VirtualClinicApptUrl>
  </Doctor>
</ArrayOfDoctor>