API Documentation

Build with Brevr

Programmatic access to link creation, analytics retrieval, and workspace management through our REST API.

Getting Started

Base URL

https://api.brevr.co/api/v1

Authentication

All API requests require an API key passed in the Authorization header. Generate API keys from your workspace settings.

Authorization: Bearer your_api_key_here

Rate Limits

API requests are rate-limited based on your plan. The current limits are returned in the response headers:

  • X-RateLimit-Limit — Maximum requests per window
  • X-RateLimit-Remaining — Requests remaining in current window
  • Retry-After — Seconds until rate limit resets (when exceeded)

Quick Start

curl -X POST https://api.brevr.co/api/v1/links \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/my-long-url",
    "alias": "my-link",
    "utmSource": "api",
    "utmMedium": "integration"
  }'

Endpoint Reference

Links

POST/api/v1/linksCreate a new short link
GET/api/v1/linksList all links with search and pagination
GET/api/v1/links/:idGet link details by ID
PATCH/api/v1/links/:idUpdate an existing link
DELETE/api/v1/links/:idDelete a link

Analytics

GET/api/v1/analytics/summaryGet click summary with trend data
GET/api/v1/analytics/timeseriesGet time-series click data
GET/api/v1/analytics/geoGeographic click breakdown
GET/api/v1/analytics/devicesDevice, OS, and browser breakdown
GET/api/v1/analytics/referrersReferrer source analysis
GET/api/v1/analytics/utmUTM parameter breakdown
GET/api/v1/analytics/exportExport analytics data (CSV/JSON)

Domains

GET/api/v1/domainsList all custom domains
POST/api/v1/domainsAdd a new custom domain
DELETE/api/v1/domains/:idRemove a custom domain
POST/api/v1/domains/:id/verifyVerify domain DNS configuration

Pixels

GET/api/v1/pixelsList retargeting pixels
POST/api/v1/pixelsCreate a retargeting pixel
PATCH/api/v1/pixels/:idUpdate a pixel
DELETE/api/v1/pixels/:idDelete a pixel

Teams

GET/api/v1/teams/membersList workspace members
POST/api/v1/teams/inviteInvite a team member
PATCH/api/v1/teams/members/:idUpdate member role
DELETE/api/v1/teams/members/:idRemove a team member

Error Codes

400Bad Request — Invalid parameters or missing required fields
401Unauthorized — Invalid or missing API key
403Forbidden — Insufficient permissions for this action
404Not Found — The requested resource does not exist
429Too Many Requests — Rate limit exceeded
500Internal Server Error — Something went wrong on our end

Ready to integrate?

Start building with the Brevr API. Create your free account and generate an API key in minutes.

Get Started FreeSign In