Skip to main content
GET
/
locations
/
search
Search locations by name
curl --request GET \
  --url https://api.istari.ai/v2/locations/search \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "location_id": "<string>",
      "name": "<string>",
      "location_type": "<string>",
      "parent_id": "<string>",
      "path": "<string>",
      "doc_count": 123
    }
  ],
  "count": 123
}

Authorizations

x-api-key
string
header
required

Your GOI API key. Create one on the GOI dashboard under API keys.

Query Parameters

q
string | null
limit
integer | null

Response

Ranked location items plus count.

items
LocationItem · object[]
required
count
integer
required