Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
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/esp \
-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
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
connected | boolean | Yes | — |
id | string | No | — |
provider | string | Yes | — |
status | string<not_connected, unverified, verified, rejected, platform, platform_key_missing> | Yes | — |
from_address | string | No | — |
marketing_from_address | string | No | Platform account only (status: platform): the From a MARKETING campaign sends as, on the separate marketing sending domain. from_address is every other purpose. |
from_local_part | string | No | — |
from_display_name | string | No | — |
sending_domain | string | No | — |
reply_to | string | No | — |
verified_domains | EspVerifiedDomain[] | No | — |
last_verified_at | string | No | — |
last_error | string | No | — |
stats | CampaignDeliveryCounts | No | ⛔ sent is NOT delivered. sent means a provider accepted the hand-off; delivered means the receiving server accepted it, which arrives later by webhook. A screen showing… |
Errors this endpoint can return
401 · 403