Participant APIs | REST

Version:
Download Open API Specification

Get listed search result for Service Provider Locations

https://beta.api.wealthcare.com/participant/services/vendors/locations

Retrieve a list of service provider locations based on specified search criteria, such as address, distance, and location types.

  • search.page integer <int32>

    The page number of the results to retrieve, useful for pagination of large result sets.

  • search.address string

    The address to search for service provider locations. This can be a full address or a partial string.

  • search.distance integer <int32>

    The maximum distance (in miles) from the specified latitude and longitude to search for locations.

  • search.locationTypes string

    A comma-separated list of location types to filter the search results, such as 'hospital', 'clinic', etc.

  • search.longitude number <double>

    The longitude coordinate used as a reference point for the location search.

  • search.latitude number <double>

    The latitude coordinate used as a reference point for the location search.

  • search.minRating number <double>

    The minimum rating (on a scale of 1 to 5) that a service provider must have to be included in the search results.

  • 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>
    • Uuid string
    • Name string
    • Latitude number <double>
    • Longitude number <double>
    • Address string
    • AddressDetail object
      • Street string
      • City string
      • State string
      • Zip string
    • GoogleMapsLink string
    • Distance number <double>
    • LocationTypes array <string>
    • Rating number <double>
    • LocationUrl string
    • PhoneNumbers array <object>
      • Phone string
    • Hours object