Linkliftr API
Everything you can do in the dashboard with links, you can do with the API. Make a key in the dashboard under API and Claude. A key belongs to one workspace and has a role: viewer (read only), editor (create and change links) or admin (also delete and read the activity log).
Sign every request
curl https://linkliftr.com/api/links \
-H "Authorization: Bearer ldk_your_key" \
-H "Content-Type: application/json" \
-d '{"destination":"https://example.com/offer","slug":"offer","tags":["launch"]}'
Answers are JSON. Errors come back with a status code and {"error":"what went wrong, in plain words"}. 402 means your plan does not include that feature. Up to 600 requests a minute per workspace (429 after that).
Endpoints
| Method | Address | What it does |
|---|---|---|
| GET | /api/me | Your workspace, plan, the key's role and the domains you can use. |
| GET | /api/links | List and search links. Query: q, tag, status (active, archived, disabled), domain, sort (new, oldest, clicks, slug), limit (up to 200), offset. |
| POST | /api/links | Create a link. Body: the link fields below; destination is required. Leave slug out for a random one. Answers 201 with the link and short_url. |
| GET | /api/links/lookup?slug=&domain= | Find a link by its slug. |
| GET | /api/check-slug?slug=&domain= | Whether a slug is free. |
| GET | /api/links/{id} | One link. |
| PATCH | /api/links/{id} | Change a link. Only the fields you send change. The slug and domain never change. |
| DELETE | /api/links/{id} | Delete a link (admin keys). |
| GET | /api/links/{id}/stats?days=30 | Clicks for one link: totals, unique visitors, by day, countries, devices, referrers, A/B and routing results. |
| GET | /api/links/{id}/qr.svg | QR code. Also qr.png?size=300|600|1200. Add plain=1 for black and white. |
| GET | /api/stats?days=30 | Workspace statistics for a period, compared with the period before: human clicks, unique visitors (each person counted once per link per day), bot clicks, by day. Filters: link, slug, tag, country, region, city, lang, device, browser, os, referrer, utm_source, utm_medium, utm_campaign, utm_term, utm_content, from, to (YYYY-MM-DD, in your workspace time zone). |
| GET | /api/stats/breakdowns?days=30 | Human clicks by region, city, language, each UTM value, hour of the day and day of the week (in your workspace time zone). Same filters as /api/stats. |
| GET | /api/clicks?from=&to=&limit=100&offset=0 | Individual clicks, oldest first, people and bots (visitor_type says which, bot_reason says why). Up to 1,000 per request; next_offset gives the next page. Dates default to the last 30 days. Same filters as /api/stats. |
| GET | /api/clicks.csv?from=&to= | The same clicks as a spreadsheet file, up to 100,000 rows per file (X-Total-Clicks gives the full count; use shorter periods for more). |
| GET | /api/tags | Tags and their groups. |
| GET | /api/audit?limit=100 | Activity log (admin keys, Pro plan). |
| POST | /api/conversions | Report a sale or sign-up: { "ref": "...", "event": "purchase", "value": 49.99, "currency": "GBP", "order_id": "..." } (Pro plan). |
| GET | /api/conversions?days=30&link= | Conversions for a period: count, rate of tracked clicks, by event, value by currency and top links (Pro plan). |
| GET | /api/conversions/funnel?days=30&link=&tag= | The funnel for a period: human clicks on tracked links, then people who signed up, then people who bought, each with the share of the step before and the drop-off; plus revenue by currency, conversions and conversion rate. The sign-up and sale event names (default signup and purchase) are set on the Conversions page (Pro plan). |
| GET | /api/bio | List bio pages. POST to create, GET/PATCH/DELETE /api/bio/{id} for one. |
| GET | /api/export.csv | Every link as a spreadsheet file. |
| POST | /api/import.csv | Create links from a CSV file sent as the body (header row must include destination; Starter plan, up to 200 rows). |
| POST | /api/hooks | Subscribe an address to one event: { "url": "https://...", "event": "link.created" }. Events: link.created, link.updated, link.deleted, link.broken, click. Answers 201 with the hook's id and its signing secret (admin keys, Pro plan). |
| GET | /api/hooks | Your hooks and webhooks (admin keys). |
| DELETE | /api/hooks/{id} | Unsubscribe (admin keys). |
| GET | /api/folders | Folders, with parent_id and link counts. POST { "name", "parent_id" } to create (one level of subfolders at most); PATCH /api/folders/{id} to rename or move; DELETE /api/folders/{id} removes it and its subfolders, and their links move to No folder. |
| GET | /api/campaigns | Campaigns. POST { "name", "starts_on", "ends_on", "utm_campaign" } to create (dates YYYY-MM-DD, optional); GET /api/campaigns/{id} gives its links and their combined statistics for the campaign dates; PATCH and DELETE /api/campaigns/{id} (its links stay). |
| POST | /api/links/bulk | Move several links at once: { "ids": [1, 2], "folder_id": 3 } and/or { "campaign_id": 4 }. Use null for No folder or no campaign. Up to 500 links. |
| GET | /api/hooks/sample?event=link.created | A made-up message for that event, in the same shape as a real one, as a list with one item. |
Link fields
| Field | Meaning |
|---|---|
destination | Full address starting https:// (required when creating) |
slug, domain | The short address. Case-sensitive. Domain defaults to your main one. |
title, notes, tags | Title; private notes (up to 2,000 characters); list of tags |
utm_source, utm_medium, utm_campaign, utm_term, utm_content | UTM values, recorded with each click and added to your own websites |
redirect_code | 302 (default) or 301 |
starts_at, expires_at | ISO 8601 times, for example 2026-12-01T09:00:00Z. Empty string removes. |
click_limit, expired_destination | Stop after this many human clicks; where to send people afterwards (Starter) |
password | Visitors must type it first. null removes it (Starter) |
country_routes | List of { countries: ["GB","IE"], destination } (Pro) |
device_routes | { ios, android, desktop } addresses (Pro) |
split_destination, split_percent | A/B test: second address and the share of clicks it gets (Pro) |
lang_routes | List of { languages: ["de","fr"], destination }, matched against the first three languages in the visitor's browser, most preferred first. Empty list removes (Pro) |
rotation | List of 2 to 10 { destination, weight } (weight 1 to 100, default 1): clicks are shared out by weight and each visitor keeps the same address. Replaces the A/B split while set. Clicks record r1, r2 and so on as the variant. Empty list removes (Pro) |
cloak | true shows the destination in a full-page frame under the short link. Refused when the page does not allow framing. Bots and link previews get a normal redirect (Pro) |
routing order | Country rules, then language rules, then device rules, then rotation (or the A/B split), then the main destination. The first that matches wins. |
pixels, open_in_app, track_conversions | Tracking pixels, open in the app on phones, conversion tracking (Pro) |
folder_id, campaign_id | The folder and campaign the link sits in; null removes. Links added to a campaign without a UTM campaign value take the campaign's. /api/links and /api/stats also take folder and campaign filters (folder includes its subfolders; /api/links takes folder=none). |
og_title, og_description, og_image | Custom social preview (Pro): what Facebook, X, LinkedIn, Slack, WhatsApp, iMessage and other link previews show. og_image is an https address or an uploaded image as a data URI (PNG, JPEG or WebP, under 300 KB); answers give og_image_ver for an upload. Empty string removes. People are always redirected as normal. |
skip_qs, hide_referrer, status | Do not pass the visitor's query string on; hide the referrer; active or archived |
Bio page fields
For /api/bio. With PATCH, only the fields you send change; sending buttons or socials replaces the whole list.
| Field | Meaning |
|---|---|
title, bio | Page title (required when creating) and a few words under it |
slug, domain | The short address of the page (when creating only) |
colour | Accent colour, like #0474AC. Text colours are picked for you so they stay readable. |
theme | light, dark, sand, mint, midnight, or bold (your colour as the background) |
button_style | outline, filled, or rounded |
buttons | List of up to 30 buttons: { "label", "url", "icon" }, and headings between them: { "type": "heading", "label" } |
socials | Icons under the title: [{ "icon": "instagram", "url": "https://..." }], each network once |
photo | Profile photo as a data URI (PNG, JPEG or WebP, under 150 KB); "" removes it. Answers show photo_url instead. |
icon names | website, email, phone, shop, youtube, instagram, tiktok, x, linkedin, facebook, spotify, whatsapp, calendar, download |
Webhooks
On Pro, the dashboard can send link.created, link.updated, link.deleted, link.broken and click events to your address. Each message has an X-Signature: t=<unix seconds>,v1=<hex> header: the HMAC-SHA256 of t + "." + body with your webhook secret. Check it, and ignore messages older than five minutes.
Sales tracking with Stripe and Shopify
On Pro, tick Track conversions on a link: each human click then carries a random reference, ld_ref, to the destination address. A sale that carries the same reference is counted for that link, with its value, currency and order number. The same order is never counted twice.
Stripe. On the dashboard's Conversions page press Connect Stripe to get your own webhook address (https://linkliftr.com/hooks/stripe/...). In Stripe, add a webhook endpoint with that address for checkout.session.completed and payment_intent.succeeded, then paste the endpoint's signing secret (whsec_...) on the Conversions page. We check the Stripe-Signature header on every message and refuse anything older than five minutes. The reference is read from metadata.ld_ref, then client_reference_id. A link that points at a Stripe Payment Link (buy.stripe.com) gets client_reference_id added for you. If you create Checkout Sessions yourself, pass the visitor's ld_ref as client_reference_id or metadata[ld_ref]. A payment reported by both events counts once (the order number is the payment's pi_... id).
Shopify. Press Connect Shopify, then in Shopify admin (Settings, Notifications, Webhooks) create an Order payment webhook (orders/paid, JSON) to your https://linkliftr.com/hooks/shopify/... address and paste the signing key Shopify shows. We check X-Shopify-Hmac-Sha256 on every message. The reference is read from the order's cart attributes (note_attributes, name ld_ref), then the landing page address (landing_site), then other addresses on the order. The Conversions page gives a short theme script that saves the reference on the cart.
Signing secrets are stored encrypted. The Conversions page shows the last message received and whether it matched a click, and can send a test event through the same checks.
Shared reports
On Pro, owners and admins can share a private report link (Shared reports page): clicks for a period, for all links or one tag, with no sign-in. Tick Include sales to add revenue, conversions and the funnel. On Agency the report shows your own name and colour and never mentions Linkliftr.
Zapier and Make
Use an admin key. Instant triggers subscribe with POST /api/hooks when a Zap or scenario is switched on and unsubscribe with DELETE /api/hooks/{id} when it is switched off. Each message is {"event": "...", "created_at": "...", "data": {...}}, signed as above; GET /api/hooks/sample?event=... gives an example for setting up the trigger. Hooks need the Pro plan and count towards the 10 webhooks a workspace can have.
On any plan, a polling trigger can ask for the newest links with GET /api/links?sort=new&limit=25: the answer's links list is newest first and each link has a unique id. Actions: create a link with POST /api/links and find one with GET /api/links/lookup?slug= or GET /api/links?q=.
Browser extension
The Linkliftr browser extension uses this API with an editor key. Browser extensions (chrome-extension:// and moz-extension:// addresses) may call the API directly; ordinary websites cannot, so keep keys on your server.
Claude
The same key works as a Claude connector. The dashboard's API and Claude page gives you the connector address and the list of tools.
Terms · Privacy · Acceptable use · Status