Search locations by name

GET

locations

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

string | null

limit

integer | null

Response

Ranked location items plus count.

items

LocationItem · object[]

required

Show child attributes

count

integer

required

List or look up locationsReturns location-tree entries from the shared `goi_locations` table. Modes: - Root: `parent_id` omitted, empty, or `null` → returns continents and countries - Children: `parent_id=<id>` → direct children of that location - Exact: `name=<name>&location_type=<type>` → exact lookup Locations are global navigation metadata — open to any caller past auth, no `regionAccess` filtering applied.

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
}