Developer API

Create a short link

POST /api/v1/links — returns a tracked short link (with click analytics) plus its QR as SVG.

Body: url (required), customCode, title, description, utm (object: source, medium, campaign, term, content) — all optional.

Send links (an array, up to 25) instead of url to create several at once; each entry succeeds or fails on its own.

curl -X POST https://sharecut.site/api/v1/links \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/very/long/link","customCode":"launch"}'

Response:

{
  "shortCode": "launch",
  "shortUrl": "https://sharecut.site/launch",
  "originalUrl": "https://example.com/very/long/link",
  "qr": { "svg": "<svg ...>" }
}

Change where a link points

PATCH /api/v1/links/{ref} — ref is the short code or the link id. A ShareCut QR code encodes the short link, not the destination, so changing the destination redirects every copy already printed, shared or stuck on a wall. The short code, the QR artwork and the click history all stay as they are.

Body: any of url, title, description, utm. The new destination is re-screened with Google Safe Browsing.

curl -X PATCH https://sharecut.site/api/v1/links/launch \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/autumn-campaign"}'

The short code itself cannot be changed here, on purpose: it is the part already printed. Rename it from the Link Studio if you really need to, and reprint.

List, read and delete links

• GET /api/v1/links — your links with click counts. Query: limit, offset, type (short, linktree, menu), q, sort (created or clicks).
• GET /api/v1/links/{ref} — one link.
• DELETE /api/v1/links/{ref} — permanent: every QR pointing at it stops working and the short code is released.

curl "https://sharecut.site/api/v1/links?sort=clicks&limit=5" \
  -H "Authorization: Bearer YOUR_KEY"

A link owned by another account answers 404, never 403 — the API cannot be used to find out which short codes exist.

Analytics and QR code of a link

GET /api/v1/links/{ref}/analytics — total clicks, a daily series (days, default 30) and breakdowns by country, device, operating system, browser and referrer.

GET /api/v1/links/{ref}/qr — the QR code, ready to print. Returns the artwork saved on the link (frames, colours, logo) when there is one, otherwise a plain code. Query: style, format, color.

curl "https://sharecut.site/api/v1/links/launch/analytics?days=7" \
  -H "Authorization: Bearer YOUR_KEY"

Account and quota

GET /api/v1/account — the plan behind the key, what it entitles, how many calls are left this month and when the counter resets, plus how many links you hold and their total clicks. Worth reading before a bulk run.

Create a QR code

POST /api/v1/qr — returns a static QR code for any URL or text.

Body: data (required), format (optional: svg default, or png), color (optional hex).

curl -X POST https://sharecut.site/api/v1/qr \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":"https://example.com","format":"svg"}'

For an editable, trackable QR, create a link first and encode its shortUrl.

Rate limits & errors

• 401 — missing, malformed or revoked API key.
• 403 — the key’s account is not on the Business plan.
• 429 — monthly quota exceeded.
• 400 — invalid input (bad URL, missing field).

Errors return JSON: { "error": "..." }.