visibility

POST /v1/visibility/targets/{targetId}/local/find

Search the map for the business, so the customer can pick theirs.

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.create; 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 POST https://api.zinndigital.com/v1/visibility/targets/{targetId}/local/find \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "query": <string>, "geo_id": <integer> }'

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

One live map search from the chosen town. It is metered as ONE check of the month's allowance (as V1 meters it) and refused with 422 when none is left. A search that finds no listing answers 200 with an empty list and uses NO check. Pick a result and save it with PUT /v1/visibility/targets/{targetId}/local.

Parameters

NameTypeRequiredWhat it is
targetId (path)UuidYesThe watched domain's id.

Request body

NameTypeRequiredWhat it is
querystringYesThe business's name.
geo_idintegerYesThe town to search from.
languagestringNo—

Response

NameTypeRequiredWhat it is
resultsLocalFindResult[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 503