API Documentation
Learn how to connect and integrate with our API.
Every request carries the account's key as a bearer token and answers JSON:API. Rate limited to 60 requests a minute per key. An update is a POST to the item's own URL (PATCH works too), and a resource that is not yours answers 404 rather than 403.
| URL | Type | Description |
|---|---|---|
/api/me | GET | The account behind the token. |
/api/user | GET | The account's full record. |
/api/logs | GET | Sign-in and account history, paged. |
/api/payments | GET | Payments on the account. |
/api/statistics | GET | Totals across every link. |
/api/statistics/{link_id} | GET | One link, by ?type= dimension. |
/api/qr-codes | GET · POST | List and create QR codes. |
/api/qr-codes/{id} | GET · POST · PATCH · DELETE | One QR code. |
/api/barcodes | GET · POST | List and create barcodes. |
/api/barcodes/{id} | GET · POST · PATCH · DELETE | One barcode. |
/api/ai-qr-codes | GET · POST | List and generate AI QR codes. |
/api/ai-qr-codes/{id} | GET · POST · PATCH · DELETE | One AI QR code. |
/api/links | GET · POST | List and create short links. |
/api/links/{id} | GET · POST · PATCH · DELETE | One short link. |
/api/projects | GET · POST | List and create projects. |
/api/pixels | GET · POST | List and create tracking pixels. |
/api/domains | GET · POST | List and create custom domains. |
/api/teams | GET · POST | Teams you own. |
/api/team-members | GET · POST | Members of teams you own. |
/api/teams-member | GET | Teams you belong to. |