ads

GET /v1/ads/connections/{connection_id}/prospecting

The Prospecting template's choices - business types, starter negatives, budget (za-158).

All ads 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 key must carry the ads.view permission; 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/ads/connections/{connection_id}/prospecting \
  -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

Gated on ads.view. On the caller's own connection. The intents (category, problem, paid-competitor alternative, brand), the match types every keyword starts on (EXACT and PHRASE), each business type with its starter negatives and whether it is paid by default, the Recommended daily budget (five whole units of the account currency, also the floor) and how many prospecting templates wait for approval (docs/1006 §93). Read from stored rows, never a network call in the request.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
dataobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 429