API Overview
Complete documentation for the Cliqer API, covering REST endpoints and WebSocket realtime communication.
Base URL
https://cliqer.io/apiAll API endpoints are relative to the base URL of the Cliqer server you're connecting to.
$BASE_URL with your Cliqer instance URL (e.g., https://cliqer.io). For WebSocket examples, replace $WS_URL with wss://cliqer.io. TypeScript examples use relative paths and work without modification.Authentication
Cliqer authenticates with an httpOnly session cookie (session_token), minted by POST /api/auth/login. Browsers send it automatically; server-to-server tooling keeps it in a cookie jar. Ultra and Enterprise teams can also mint API keys for server-to-server REST requests, sent as Authorization: Bearer cliqer_<key> (key management requires the Ultra or Enterprise plan). The WebSocket does not take API keys: connect it with a session token.
# The session cookie is set by /api/auth/login and sent on every subsequent request
Cookie: session_token=YOUR_SESSION_TOKEN
# Or authenticate a server-to-server REST request with a team API key
Authorization: Bearer cliqer_<key>
A few endpoints need no session, such as POST /api/licenses/validate, which is public.
API Sections
Request Lifecycle
Error Responses
All endpoints return standard error responses:
| Status | Description |
|---|---|
400 | Bad Request - Missing or invalid parameters |
401 | Unauthorized - No valid session cookie |
403 | Forbidden - Insufficient permissions or disallowed origin |
404 | Not Found - Resource not found |
409 | Conflict - e.g. licence activation seat limit reached |
429 | Too Many Requests - Rate limit exceeded (see Retry-After) |
500 | Internal Server Error |
Error Response Format:
{
"statusCode": 400,
"statusMessage": "Description of the error"
}
Rate Limiting
Most endpoints are rate-limited per client IP, using a fixed 60-second window across three tiers. When a request exceeds the limit the server responds 429 Too Many Requests with a Retry-After: 60 header. There is no progressive/exponential blocking, and no X-RateLimit-Remaining header is returned.
| Header | Description |
|---|---|
Retry-After | Seconds until the window resets (60, sent only on a 429) |
Rate Limit Tiers
| Tier | Requests / 60s | Applied to |
|---|---|---|
| Strict | 5 | POST /api/licenses/validate and the sign-in endpoints (POST /api/auth/login, registration, password reset, passkey and 2FA steps) |
| Standard | 30 | GET /api/licenses/status, POST /api/licenses/deactivate, GET /api/auth/me, POST /api/auth/logout |
| Relaxed | 60 | High-volume read endpoints |
Two endpoints apply a second Strict limit keyed on the credential rather than the IP, so one target cannot be hammered across many addresses: POST /api/licenses/validate keys on the license_key, and POST /api/auth/login keys on the email address.
429 for the remainder of the 60-second window. Rate limits are enforced by the server itself, before the endpoint does its work.