Base URL
/api/v1/, in the form /api/v1/<resource>/<action>.
Your first request
Create an API key in the dashboard under Settings → API Keys, then:How responses are shaped
Every response is wrapped, so one code path handles every endpoint. A success puts the payload underdata:
error:
What you can do
Links
Create, update, search and bulk-manage Shortlinks.
QR Codes
Generate styled QR codes backed by trackable Shortlinks.
App Dynamic Links
Route to a native app when installed, the web when not.
Campaigns
Group links into campaigns and channels.
Analytics
Clicks, scans and visitors, by organization, link or campaign.
Branded Links
Serve links from a domain you own.
Tags
Organise and filter links and QR codes.
UTM Templates
Keep campaign tagging consistent across your team.
Conventions worth knowing up front
Deletion is bulk-only
Deletion is bulk-only
There are no single-resource delete endpoints for links, QR codes or UTM templates. To delete one, pass a one-element array to the bulk endpoint. This keeps one code path for deleting one thing and deleting a thousand, and one result shape to interpret. See Bulk operations.
Writes are form-encoded, not JSON
Writes are form-encoded, not JSON
POST bodies use application/x-www-form-urlencoded, or multipart/form-data when a file is involved. Array parameters such as tags or shortlink_ids are sent as JSON-encoded strings within the form body.Another organization's resource returns 404
Another organization's resource returns 404
Asking for a resource that exists but belongs to someone else returns
404, not 403. A 403 would confirm the id is real, which would let anyone map out other customers’ ids by trying them.List sizes are clamped, not rejected
List sizes are clamped, not rejected
per_page above the maximum of 100 returns 100 rather than an error. The response echoes the per_page actually applied. See Pagination.Next
Authentication
Create a key and scope it.
Rate limits
What your plan allows.
Errors
Every code and what to do about it.