REST API
Twelve endpoints. The whole product.
Stable v1 since 2024. Versioned with deprecation headers.
| Method | Path | Purpose |
|---|---|---|
| POST | /v1/links | Create a smart link |
| GET | /v1/links | List links · paginated |
| GET | /v1/links/{slug} | Read a link + its rules |
| PATCH | /v1/links/{slug} | Update rules, slug, or domain |
| DELETE | /v1/links/{slug} | Archive a link |
| POST | /v1/links/bulk | Create up to 1,000 in one request |
| GET | /v1/links/{slug}/clicks | Stream raw clicks (JSONL) |
| GET | /v1/links/{slug}/stats | Aggregated by country / OS / UTM |
| POST | /v1/qr/{slug} | Generate a styled QR · PNG/SVG/PDF |
| GET | /v1/domains | List custom domains |
| POST | /v1/webhooks | Subscribe to click / conversion events |
| GET | /v1/usage | Current month clicks + plan limits |
v1.4.2
Node.js
TypeScript
v1.2.0
Swift
iOS 14+
v1.4.0
Kotlin
Android 8+
v1.1.0
Go
Modules
v1.3.1
Python
Py 3.10+