API and integrations
API & Integrations (Owner and Administrator) issues tokens so other systems can create links and read analytics.
Creating a token
Under Create a token:
- What is it for? A name, such as "Campaign automation".
- What may it do? Tick the permissions it needs. You can only give a token permissions you hold yourself, and if your own role is reduced later, the token's access is reduced with it.
- Expires after (days, optional). 1 to 365. Leave it blank for a token that does not expire.
Click Create token. Copy the token straight away: it is shown once and cannot be shown again, by anyone.
A token works in the current workspace only.
Managing tokens
Tokens in this workspace lists every token that can reach the workspace's data, including colleagues', with how many permissions it has, when it was last used (or "never used") and when it expires. Revoke stops it working immediately.
Using the API
Send the token as a bearer header. Start with GET /api/v1/me to confirm which workspace it reaches; the page shows a ready-made example for your address.
| Endpoint | Does | Token permission |
|---|---|---|
GET /api/v1/me |
Workspace and token details | Any |
GET /api/v1/links |
List links | View analytics |
GET /api/v1/links/{id} |
One link | View analytics |
GET /api/v1/links/{id}/analytics |
A link's figures | View analytics |
GET /api/v1/links/{id}/qr |
A link's QR code | View analytics |
POST /api/v1/links |
Create a link | Create links |
PATCH /api/v1/links/{id} |
Update a link | Edit links |
POST /api/v1/links/{id}/disable |
Disable a link | Edit links |
POST /api/v1/links/{id}/archive |
Archive a link | Delete links |
GET /api/v1/campaigns |
List campaigns | View analytics |
GET /api/v1/campaigns/{id} |
One campaign | View analytics |
GET /api/v1/campaigns/{id}/analytics |
A campaign's figures | View analytics |
POST /api/v1/campaigns |
Create a campaign | Create campaigns |
PATCH /api/v1/campaigns/{id} |
Update a campaign | Edit campaigns |
Lists are paginated, up to 100 per page. The same rules apply as in the app: the active-link allowance, alias rules and destination checks. Requests are rate-limited per minute for each token, with a lower limit for changes than for reads. A request over the limit is refused with 429 Too Many Requests; wait a moment and try again.