Build integrations and automate your URL shortener workflows with the Zappr REST API.
API calls from the dashboard use NextAuth session cookies automatically. No headers needed.
Pass your API key in the Authorization header as a Bearer token.
Authorization: Bearer za_<your-api-key>
Generate keys at Settings → API Keys. API keys inherit your plan's rate limits and Pro features.
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /api/health | None | Check service health and version |
| POST | /api/shorten | None | Create a public short link (24h expiry, no auth required) |
| GET | /api/links | Session or API Key | List your short links with search, filter, and pagination |
| POST | /api/links | Session or API Key | Create a new short link with custom slug, password, and expiry |
| PATCH | /api/links/{id} | Session or API Key | Update an existing short link |
| DELETE | /api/links/{id} | Session or API Key | Archive (soft-delete) a short link |
| GET | /api/domains | Session or API Key | List your custom domains with verification status |
| POST | /api/domains | Session or API Key (Pro) | Add a custom domain with DNS verification instructions |
| GET | /api/domains/{id} | Session or API Key | Get domain details and link count |
| POST | /api/domains/{id} | Session or API Key | Re-verify domain DNS records |
| DELETE | /api/domains/{id} | Session or API Key | Remove a custom domain and disconnect links |
| GET | /api/user/keys | Session or API Key | List your API keys (full key shown once on creation) |
| POST | /api/user/keys | Session or API Key | Create a new API key for programmatic access |
| DELETE | /api/user/keys/{id} | Session or API Key | Revoke an API key |