NEnexhealth
intent

Find practices by location

Returns granted practice locations near a point, ranked by distance. Soft failures return { ok: false, reason:, message: } rather than an HTTP error.

Example request

curl -X POST https://nexhealth.info/intent/locations/search \
  -H 'Authorization: Bearer <token>' -H 'Content-Type: application/json' \
  -d '{ "location": { "zip": "98101" }, "radius_miles": 15 }'

Example success response

{ "ok": true,
  "locations": [
    { "location_id": 42, "name": "Main St Dental",
      "address": "1 Main St, Seattle, WA, 98101", "distance_miles": 1.2 }
  ] }

Reason catalog (branch on reason when ok is false)

reasonMeaningRecommended agent recovery
location_requiredNo location input supplied.Ask the user for a ZIP, city, or coordinates and re-call.
location_not_understoodThe input could not be resolved to coordinates.Ask for a 5-digit US ZIP or lat/lng and re-call.
no_locations_in_radiusNo granted practices within the radius.Widen radius_miles or ask for a different area.
post/intent/locations/search

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/intent/locations/search
  • Auth
    API key in header Authorization

Request body

radius_milesnumber float

Search radius in miles (default 20, must be positive).

Response

Find practices by location

Changes

No recorded changes to this operation across all 1 revision of this API.