7 days free, live today on a shared address. Plans from £3.99 a month, own domains from £14 a year. Start free

API reference

Editing over the API

Create and change pages, links and poplinks over the API with an edit key, and what needs an explicit confirm.

#An edit key

Make one at Dashboard › API and choose Read and edit. Only the account owner can. Thirty changes an hour per key, inside the sixty requests. Bodies are JSON. A field we do not know is refused rather than ignored, so a typo cannot look like a save.

#Pages

CallWhat it does
POST /api/v1/pagesA new page from {"slug": "..."} plus any page fields. Always a draft. Counts against the plan's pages
GET /api/v1/pages/:pageThe page in full. :page is its id or slug
PATCH /api/v1/pages/:pageChange fields. Send only the ones that change
POST /api/v1/pages/:page/duplicateA paused copy at slug-copy

Page fields: name, handle, bio, hero, theme, font, shape, colours ({bg, ink, button, button_text}, or null to clear), capture, capture_label, listed, countdown ({at, label, done}), iab_mode, preview, geo_block, geo_mode, human_check, deeplink, stars, translate, followers_on, badge, smart_loc, verified, tags, iab_title, iab_hero, and links and socials as arrays of {id?, label, url, adult}: with an id it changes that one, without it adds one.

These need "confirm": true, because they can take a page offline or change who can see it: slug, status (live or paused), domain (one of yours, from /api/v1/domains), shield and crawler_mode. Without it you get a 409 naming them, and nothing changes.

curl -X PATCH https://peekin.bio/api/v1/pages/yourname   -H "Authorization: Bearer pk_live_YOUR_EDIT_KEY"   -H "Content-Type: application/json"   -d '{"bio": "New shoot every Friday", "status": "live", "confirm": true}'
A page only goes live on a plan that publishes; until then it stays a draft and the call says why. With no active domain of its own it goes live on a shared address.

#Analytics, domains, slugs

CallWhat it returns
GET /api/v1/analytics?page=&link=&days=Per page: days[] of views, paid taps, social taps and people, and links[] with taps per link. days is 1, 7, 28 or 90
GET /api/v1/live?page=The last thirty minutes: views, taps and minutes[], thirty [views, taps] pairs, oldest first. Creator and up
POST /api/v1/importA new draft page from a link.me, Linktree, Beacons, AllMyLinks, Bouncy or bio.link address: {"url": "..."}. Answers page, counts and a message. Edit key, ten an hour
GET|POST /api/v1/link-healthLink Health: targets, this month’s allowance and recent runs; POST {"target": "page:12", "world": true} runs one. GET /api/v1/link-health/<scan> reads one run
GET /api/v1/domainsEach domain, its status and the page it shows
GET /api/v1/slug-check?slug={"ok": true} when the address is free

#The audit log

Every change made with a key is written to the account's audit log with the key's id, next to the changes people make in the dashboard. Owners and Admins read it on Team.