Links

{
  "id": "9d2b7c15-4e3a-4b88-9f21-0a6c5d3e7b90",
  "label": "Our catalogue",
  "url": "https://example.com/catalogue",
  "icon": "book",
  "position": 0,
  "visible": true,
  "created_at": "2026-03-01T09:14:02.554311+00:00",
  "updated_at": "2026-03-01T09:14:02.554311+00:00"
}

position is the display order, ascending. It does not have to be unique or contiguous; ties break by id, so leaving everything at 0 gives a stable but arbitrary order. url must be http, https, mailto: or tel:.

Links are unlimited in practice. A page holds at most 1,000 links, here and in the dashboard alike: a safety ceiling the same on every plan, which keeps a page fast to open on a phone (links_per_page in GET /v1/usage). A page that already had more when its ceiling was lowered keeps every one of them: they are all listed, and each can still be edited, moved or removed. Nothing is added to it until it is under the ceiling again.

Operations

GET /v1/pages/{slug}/links

List a page's links

Scope pages:read. Another workspace's answers 404.

Every link on the page, in display order, with no cursor. Links are unlimited in practice: a page holds at most 1,000 links, a safety ceiling the same on every plan (links_per_page in GET /usage). A page that already had more when its ceiling was lowered keeps every one of them, and all of them are listed here.

Parameters

Answers

Every link on a page, in display order — answers 200

One response, never paged. The cap is enforced on the write, not only on the read, so there is no link you could create and then not see here.

curl https://api.boltclaw.ai/v1/pages/acme/links \
  -H "Authorization: Bearer bc_live_EXAMPLExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const res = await fetch("https://api.boltclaw.ai/v1/pages/acme/links", {
  headers: {
    Authorization: `Bearer ${process.env.BOLTCLAW_KEY}`,
  },
});

// 200
const data = await res.json();

POST /v1/pages/{slug}/links

Add a link

Scope pages:write. Accepts Idempotency-Key. Another workspace's answers 404. Can make something publicly visible.

Adds a link to the page. A page holds at most 1,000 links, a safety ceiling the same on every plan (links_per_page in GET /usage): adding one to a page at its ceiling is 409 CONFLICT. A page that had more when its ceiling was lowered keeps them all, and you can still edit, reorder and remove them, but nothing is added to it until it is under the ceiling. A label longer than your organisation's link_label_chars (120 by default) is 400.

Parameters

Request body (required)

{
  "url": "<url>"
}

Answers

PATCH /v1/links/{id}

Update a link

Scope pages:write. Another workspace's answers 404. Can make something publicly visible.

Changes the fields you send.

Parameters

Request body (required)

Answers

Move a link — answers 200

position is ascending and ties break by id, so a page whose links all sit at 0 has a stable but arbitrary order.

curl -X PATCH https://api.boltclaw.ai/v1/links/9d2b7c15-4e3a-4b88-9f21-0a6c5d3e7b90 \
  -H "Authorization: Bearer bc_live_EXAMPLExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
  "position": 1
}'

const res = await fetch("https://api.boltclaw.ai/v1/links/9d2b7c15-4e3a-4b88-9f21-0a6c5d3e7b90", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.BOLTCLAW_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "position": 1
  }),
});

// 200
const data = await res.json();

DELETE /v1/links/{id}

Remove a link

Scope pages:write. Another workspace's answers 404.

Removes the link from its page. Ordinary page editing, so pages:write is enough.

Parameters

Answers

Shapes

The objects these operations send and answer.

Deleted

Link

LinkCreate

LinkList

LinkUpdate