links

GET /v1/content/link-sets/{linkSetId}

One link set, with its resolved distribution.

All links endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the links.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/content/link-sets/{linkSetId} \
  -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 links.view. Carries the same distribution the list does — the resolved share of every (URL, wording) pair, computed by the function a recipe run actually uses, so the preview and the placements cannot disagree.

Parameters

NameTypeRequiredWhat it is
linkSetId (path)stringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
namestringYes—
notesstringYes—
is_archivedbooleanYesAn archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused.
entriesLinkSetEntry[]Yes—
created_atstringYes—
updated_atstringYes—
recipe_countintegerYesHow many recipes point at this set — so a delete button can say so first.
distributionobject[]YesThe resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses.
distribution_errorstringYesWhy there is no distribution, or empty. Separate from distribution because an empty list also means "this set has no links", and one value for two facts is not an answer.

Errors this endpoint can return

401 · 403 · 404