links
GET /v1/content/link-sets/{linkSetId}
One link set, with its resolved distribution.
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/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
| Name | Type | Required | What it is |
|---|---|---|---|
linkSetId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
notes | string | Yes | — |
is_archived | boolean | Yes | An 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. |
entries | LinkSetEntry[] | Yes | — |
created_at | string | Yes | — |
updated_at | string | Yes | — |
recipe_count | integer | Yes | How many recipes point at this set — so a delete button can say so first. |
distribution | object[] | Yes | The resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses. |
distribution_error | string | Yes | Why 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