Get list of Service Providers
Retrieve a list of service providers based on various search criteria, allowing users to find providers that meet their specific needs.
Request
-
search.page integer <int32>
The page number for pagination, formatted as an integer (int32). This parameter helps in retrieving results in a paginated manner.
-
search.address string
A string representing the address to filter service providers. This helps narrow down the search results to specific locations.
-
search.specialityIds string
A comma-separated list of specialty IDs to filter the search results. This allows users to find providers with specific specialties.
-
search.speciality string
A string representing the specialty to filter service providers. This parameter is useful for users looking for providers in a particular field.
-
search.insuranceIds string
A comma-separated list of insurance IDs to filter the search results. This helps users find providers that accept specific insurance plans.
-
search.name string
A string representing the name of the provider to search for. This parameter allows users to find providers by their names.
-
search.locationIds string
A comma-separated list of location IDs to filter the search results. This helps in narrowing down providers based on specific locations.
-
search.latitude number <double>
The latitude coordinate for location-based searches, formatted as a double. This parameter is used to find providers near a specific geographic point.
-
search.longitude number <double>
The longitude coordinate for location-based searches, formatted as a double. This parameter works in conjunction with latitude to pinpoint provider locations.
-
search.npis string
A comma-separated list of National Provider Identifiers (NPIs) to filter the search results. This allows users to find specific providers by their NPIs.
-
search.minConfidence integer <int32>
An integer representing the minimum confidence level for the search results (int32). This parameter helps in filtering results based on the reliability of the match.
-
search.excludeAddress string
A string representing an address to exclude from the search results. This helps refine the results by omitting certain locations.
-
search.excludeSpecialityIds string
A comma-separated list of specialty IDs to exclude from the search results. This parameter allows users to filter out providers with specific specialties.
-
search.excludeSpeciality string
A string representing a specialty to exclude from the search results. This helps users avoid providers in certain fields.
-
search.excludeInsuranceIds string
A comma-separated list of insurance IDs to exclude from the search results. This helps users find providers that do not accept certain insurance plans.
-
search.excludeName string
A string representing a provider name to exclude from the search results. This parameter allows users to filter out specific providers.
-
search.excludeLocationIds string
A comma-separated list of location IDs to exclude from the search results. This helps refine the results by omitting certain locations.
-
search.excludeLocation string
A string representing a location to exclude from the search results. This parameter helps users avoid certain geographic areas.
-
search.excludeNpis string
A comma-separated list of NPIs to exclude from the search results. This allows users to filter out specific providers by their NPIs.
-
search.excludeMinConfidence string
A string representing the minimum confidence level to exclude from the search results. This parameter helps in filtering out less reliable matches.
Response
-
parameters object
-
total_count integer <int32>
Total count
-
page integer <int32>
Page
-
page_size integer <int32>
Page size
-
sort_by string
Sort by
-
description string
-
-
data array <object>
-
Age integer <int32>
-
Degrees array <string>
-
Educations array <object>
-
Type string
-
Education object
-
Uuid string
-
Name string
-
-
Year integer <int32>
-
-
FirstName string
-
Gender string
-
Insurances array <object>
-
Id string
-
CarrierAssociation string
-
CarrierBrand string
-
CarrierName string
-
DisplayName string
-
PlanName string
-
-
Languages array <string>
-
LastName string
-
Locations array <object>
-
Address string
-
AddressDetails object
-
City string
-
State string
-
Street string
-
Zip string
-
-
GoogleMapsLink string
-
Latitude number <float>
-
Longitude number <float>
-
Name string
-
Uuid string
-
PhoneNumbers array <object>
-
Phone string
-
Details string
-
-
-
MiddleName string
-
Npi string
-
OnlineProfiles array <object>
-
Url string
-
-
ProviderTypes array <string>
-
RatingsAvg number <float>
-
RatingsCount integer <int32>
-
Specialities array <object>
-
BoardSpeciality string
-
BoardSubSpeciality string
-
Colloquial string
-
Display string
-
NonMdSpeciality string
-
NonMdSubSpeciality string
-
ProviderName string
-
Taxonomy1 string
-
Taxonomy2 string
-
Taxonomy3 string
-
TaxonomyCode string
-
Uuid string
-
-