visibility

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

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

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 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. Pick a result and save it with PUT /v1/visibility/targets/{targetId}/local.

Parameters

Name	Type	Required	What it is
`targetId (path)`	`Uuid`	Yes	The watched domain's id.

Request body

Name	Type	Required	What it is
`query`	`string`	Yes	The business's name.
`geo_id`	`integer`	Yes	The town to search from.
`language`	`string`	No	—

Response

Name	Type	Required	What it is
`results`	`LocalFindResult[]`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 503

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