Get list of Service Providers
Retrieve a list of service providers based on various search criteria, allowing users to find suitable providers for their needs.
-
search.page integer <int32>
The page number of the results to retrieve, formatted as an integer (int32). This parameter is useful for pagination of results.
-
search.address string
The address to search for service providers. This parameter helps narrow down the search 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 qualifications.
-
search.speciality string
The specialty to search for among service providers. This parameter helps users find providers based on their specific medical needs.
-
search.insuranceIds string
A comma-separated list of insurance IDs to filter the results. This ensures that the returned providers accept the specified insurance plans.
-
search.name string
The name of the service provider to search for. This parameter allows users to find specific providers by name.
-
search.locationIds string
A comma-separated list of location IDs to filter the search results. This helps in finding providers in specific areas.
-
search.latitude number <double>
The latitude coordinate for location-based searches. This parameter is used in conjunction with longitude to pinpoint specific areas.
-
search.longitude number <double>
The longitude coordinate for location-based searches. This parameter is used alongside latitude to identify specific locations.
-
search.npis string
A comma-separated list of National Provider Identifiers (NPIs) to filter the search results. This allows users to find providers by their unique identifiers.
-
search.minConfidence integer <int32>
The minimum confidence level for the search results, formatted as an integer (int32). This parameter helps in filtering results based on the reliability of the match.
-
search.excludeAddress string
An address to exclude from the search results. This parameter helps refine the search by omitting specific locations.
-
search.excludeSpecialityIds string
A comma-separated list of specialty IDs to exclude from the search results. This allows users to filter out providers with certain specialties.
-
search.excludeSpeciality string
A specialty to exclude from the search results. This parameter helps users avoid providers with specific qualifications.
-
search.excludeInsuranceIds string
A comma-separated list of insurance IDs to exclude from the search results. This ensures that the returned providers do not accept the specified insurance plans.
-
search.excludeName string
A name to exclude from the search results. This parameter allows users to filter out specific providers by name.
-
search.excludeLocationIds string
A comma-separated list of location IDs to exclude from the search results. This helps in avoiding providers in certain areas.
-
search.excludeLocation string
A location to exclude from the search results. This parameter allows users to filter out providers based on specific locations.
-
search.excludeNpis string
A comma-separated list of NPIs to exclude from the search results. This allows users to avoid specific providers by their unique identifiers.
-
search.excludeMinConfidence string
A minimum confidence level to exclude from the search results. This parameter helps in filtering out results that do not meet a certain reliability threshold.
-
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
-
-