API Reference

The Brevr REST API lets you create and manage short links programmatically — from your CMS, deployment pipeline, or any system that can make an HTTP request.

Base URL


https://app.brevr.io/api/v1

All endpoints are relative to this base URL.

Authentication

Brevr uses API keys to authenticate requests. Pass your key in the Authorization header:


Authorization: Bearer YOUR_API_KEY

Generate API keys from your workspace Settings → API Keys. Keys are shown once at creation — store them in a secrets manager or environment variable.

To revoke a key, delete it from Settings → API Keys. It stops working immediately.

Rate Limits

Requests are rate-limited per workspace. The limit depends on your plan:

Plan	Requests per minute
Free	100
Pro	600
Business	1,200
Enterprise	3,000

When you exceed the limit, the API returns 429 Too Many Requests. Retry after the window resets.

Rate limit headers are included on every response:

Header	Description
`X-RateLimit-Limit`	Maximum requests allowed in the current window
`X-RateLimit-Remaining`	Requests remaining in the current window
`X-RateLimit-Reset`	Unix timestamp when the window resets

Response Format

All responses are JSON. Successful requests return 200 OK or 201 Created.

Success


{
  "link": {
    "id": "clx1234...",
    "shortCode": "my-link",
    ...
  }
}

Errors


{
  "error": "A human-readable description of what went wrong."
}

Common status codes:

Status	Meaning
`400 Bad Request`	Invalid request body or parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Valid key but insufficient permissions
`404 Not Found`	Resource does not exist in your workspace
`409 Conflict`	Duplicate short code or slug
`422 Unprocessable Entity`	Validation failed (e.g. invalid URL format)
`429 Too Many Requests`	Rate limit exceeded
`500 Internal Server Error`	Something went wrong on our end

Workspace Scoping

All resources (links, tags, domains) are scoped to the workspace the API key belongs to. You cannot access resources from other workspaces with a single key.

What’s Available via API

The public API currently covers link management. Dashboard features like analytics, custom domains, team management, and billing are available only through the web interface.

Create, list, retrieve, update, delete, and bulk import short links.

Links