API reference
API reference
In short
These are the 31 endpoints an API key can call. Each page has an example in nine languages, every field, and the errors you can get back.
- Base URL
https://app.clik.so/api- Auth
Authorization: Bearer clik_live_…on every request. How keys work- Format
- JSON in, JSON out, in one envelope. Requests and responses
- Limits
- Per key, per minute, by plan. Limits
Links
Create, read, update and delete short links, one at a time or up to 100 at once.
- GET
/linksList links - POST
/linksCreate a link - GET
/links/{id}Get a link - PUT
/links/{id}Update a link - DEL
/links/{id}Delete a link - PATCH
/links/bulkUpdate many links - DEL
/links/bulkDelete many links - GET
/links/slug-checkCheck a slug - GET
/links/generate-slugGenerate a random slug - POST
/links/ai-slugSuggest slugs with AI - POST
/links/ai-slug/consumeGet AI slug usage - POST
/links/og-previewPreview a page's social card
Folders
Group links into folders. Each link sits in at most one folder.
Tags
Label links with coloured tags. A link can carry any number of tags.
Domains
Read the domains your links can use, including your verified custom domains.
Workspace
Read your workspace's plan, limits, usage and domain preferences.
Analytics
Read click counts, breakdowns, time series and raw clicks for your links.