List or look up locations

GET

locations

curl --request GET \
  --url https://api.istari.ai/v2/locations \
  --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

parent_id

string | null

name

string | null

location_type

string | null

limit

integer | null

Response

Location items plus count.

items

LocationItem · object[]

required

Show child attributes

count

integer

required

Search locations by nameRanked search over `goi_locations.name` with exact, prefix, substring, and fuzzy (trigram) layers. Returns the same item shape as `/v1/locations`. Open to any caller past auth.

List or look up locations

curl --request GET \
  --url https://api.istari.ai/v2/locations \
  --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
}