visibility

GET /v1/visibility/local/places

Towns a local search can be made from.

All visibility endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/visibility/local/places?country=<country>&q=<q> \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Searches Google's own place list for one country — towns, post towns, counties, regions and the country itself. Free (it costs no check). The town's own name matches first. Returns at most twenty.

Parameters

NameTypeRequiredWhat it is
country (query)stringYesISO 3166-1 alpha-2 country code, such as GB.
q (query)stringYesAt least two characters of the place's name.

Response

NameTypeRequiredWhat it is
placesLocalPlaceOption[]Yes—

Errors this endpoint can return

401 · 403 · 422 · 503