ads
GET /v1/ads/offerings
Search the things the organisation advertises (sites, products, services, apps, locations, events, lead forms, offers).
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.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/offerings \
-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 (za-290). No cap on how many an organisation has: the list is keyset paginated by name (next_cursor), filtered by q (name or host), kind and tag, and costs two queries per page whatever its size. Archived offerings are listed only with archived=true. campaigns is how many campaigns are assigned to each.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
q (query) | string | No | — |
kind (query) | AdsOfferingKind | No | — |
tag (query) | string | No | — |
archived (query) | boolean | No | — |
cursor (query) | string | No | — |
limit (query) | integer | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsOffering[] | Yes | — |
next_cursor | string | Yes | — |
Errors this endpoint can return
401 · 422 · 429