links

GET /v1/content/campaigns/{campaignId}

One campaign's queue — what is scheduled, and when each lands.

All links endpoints

All developer docs

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/content/campaigns/{campaignId} \
  -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

Every article in the campaign, in the order it will go out, with its topic, its moment and whether it can still be moved. Gated on links.view.

Parameters

NameTypeRequiredWhat it is
campaignId (path)stringYes

Response

NameTypeRequiredWhat it is
campaign_idstringYes
briefstringYes
totalintegerYes
pendingintegerYes
doneintegerYes
failedintegerYes
pausedintegerYes
cancelledintegerYes
next_atstringNo
last_atstringNo
site_countintegerYes
runsContentCampaignRun[]Yes

Errors this endpoint can return

401 · 403 · 404