visibility
GET /v1/visibility/local/places
Towns a local search can be made from.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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
| Name | Type | Required | What it is |
|---|---|---|---|
country (query) | string | Yes | ISO 3166-1 alpha-2 country code, such as GB. |
q (query) | string | Yes | At least two characters of the place's name. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
places | LocalPlaceOption[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 503