links

GET /v1/content/link-sets

Your reusable link sets — the URLs you build links to, and the words for each.

All links endpoints

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.

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/content/link-sets \
  -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

A link set is a named list of destinations and, for each one, every anchor text you want used for it. Recipes point at a set rather than carrying their own copy, so a URL that changes changes in one place. Gated on `links.view`. Each row carries a `distribution`: the resolved share of every (URL, wording) pair, summing to 100. That is computed by the **same** function a recipe run uses, so the preview on screen and the links actually placed cannot disagree. When the shares cannot be resolved, `distribution` is empty and `distribution_error` says why — the two are separate fields because an empty list also means "this set has no links", and one value for two facts is not an answer.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo
include_archived (query)booleanNo

Response

NameTypeRequiredWhat it is
itemsLinkSet[]Yes
totalintegerYes

Errors this endpoint can return

401 · 403