campaigns
GET /v1/campaigns/segments/fields
The filter vocabulary, its value lists and the magic tags.
Authentication
Send an API key as a bearer token. The endpoint checks campaigns.view; 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/campaigns/segments/fields \
-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
Everything a segment builder needs to render itself: the filterable fields with their operators and a hint each, the live value lists for the choice fields, and the merge tags a template may use. The value lists are restricted to your own population — a reseller's country picker lists the countries their clients are actually in, not every country the platform sells into.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
fields | CampaignSegmentField[] | Yes | — |
choices | object | Yes | Live value lists, restricted to your own population. |
merge_tags | string[] | Yes | The magic tags a template may use. Every one resolves to a STRING for every recipient — never null, never absent, so no message can begin "Hi ,". |
scope | string<platform, reseller> | Yes | — |
org_id | string | Yes | — |
Errors this endpoint can return
401 · 403