ads

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

One Prospecting preview - building, ready with the plan, failed or expired (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/{preview_id} \
  -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. building while the workflow runs, ready with the plan, failed with the refusal (error.code, as for buildAdsProspecting), expired once the run is no longer kept or finished more than a day ago (its account read is stale: build it again).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—
preview_id (path)stringYes—

Response

NameTypeRequiredWhat it is
dataobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429