Brevr REST API — Automate Your Links

The Brevr API lets you create, manage, and analyze links without ever opening the dashboard. Connect it to your CMS, marketing platform, or internal tools to automate repetitive link work.

What You’ll Learn

• What you can do with the Brevr API
• How to generate your API key
• Rate limits by plan
• Common use cases for marketers and growth teams
• Where to find the full API reference

What You Can Do with the API

The API gives you programmatic access to the core features of your Brevr account.

📸 Screenshot: [API reference page showing available endpoints]

• Create and edit links — Build short links in bulk or on the fly from any system that can make an outbound web request.
• Retrieve analytics data — Pull click counts, geographic data, device breakdowns, and UTM performance into your own dashboards or spreadsheets.
• Manage custom domains — Add, update, or remove domains attached to your workspace.
• List and organize links — Search, filter, and tag links from outside the Brevr interface.

If you can do it in the Brevr dashboard, you can likely do it through the API.

How to Get Your API Key

Your API key is the credential that tells Brevr your requests are coming from you. Keep it private — treat it like a password.

📸 Screenshot: [Settings → API Keys page with a key listed and a “Create Key” button]

1. Open Settings in your Brevr sidebar.
2. Click API Keys.
3. Click Create Key.
4. Name the key so you remember what it is for (for example, “CMS Integration” or “Analytics Pipeline”).
5. Copy the key immediately. Brevr only shows it once. Store it somewhere safe.
6. Add your API key to the Authorization header of your requests. Your developer or the tool you are connecting to will handle this step.

To revoke a key, return to Settings → API Keys and delete it. The key stops working immediately.

Rate Limits by Plan

Brevr limits how many API requests you can make per minute to keep the service fast for everyone.

If you exceed your rate limit, requests will be rejected temporarily. Your system can retry after a short wait. For sustained high-volume usage, upgrade your plan or contact us about Enterprise.

Common Use Cases

Here are the most popular ways marketing and growth teams use the Brevr API.

📸 Screenshot: [Example of links created automatically with campaign tags]

• CMS integration — Your content management system creates a Brevr short link automatically every time a new blog post or landing page is published.
• Campaign automation — A campaign management tool generates hundreds of unique links for email or SMS sends, each tagged with UTM parameters, without manual entry.
• Analytics pipeline — Your internal reporting system pulls Brevr click data nightly and combines it with conversion data from your CRM or ad platform.
• Custom link portal — Your team has an internal tool that lets non-technical users create branded links without logging into Brevr directly.

Where to Find the Full API Docs

This page is a plain-language introduction. For full endpoint details — request formats, response shapes, filtering options, and error codes — visit the API reference.

View the Full API Reference →

The reference includes interactive examples so you can try requests directly from your browser.

Frequently Asked Questions

Do I need a developer to use the API?

For direct API calls, yes — some technical knowledge is required. However, many no-code tools (like Zapier, Make, or n8n) can connect to the Brevr API without writing any code. Check those platforms for a Brevr integration or use their HTTP request modules with your API key.

Can I have multiple API keys?

Yes. You can create as many keys as you need. Use separate keys for separate systems so you can revoke one without breaking others.

Is the API available on the Free plan?

Yes, with lower rate limits. Free plan users get 100 requests per minute, which is enough for light automation and testing.

What happens if I accidentally expose my API key?

Revoke it immediately in Settings → API Keys and create a new one. Update your systems with the new key before the old one is deleted.

Watch the Full Walkthrough

🎬 Video walkthrough: [Getting Started with the Brevr API — ~2 min]

Walk through every step below with the screenshots to follow along at your own pace.

Step 1: Open API Keys in Settings

Navigate to your Brevr dashboard and click Settings in the sidebar. Then click API Keys to open the key management page.

📸 Screenshot: [Brevr sidebar with Settings highlighted, and the API Keys menu item visible in the settings navigation]

Step 2: Create a New API Key

Click Create Key to generate a new credential. Give it a descriptive name — for example, “CMS Integration” or “Analytics Pipeline” — so you can identify it later if you need to revoke it.

📸 Screenshot: [Create Key modal with a name field filled in, e.g. “CMS Integration”, and a Create button]

Step 3: Copy Your Key Immediately

Brevr shows your API key exactly once. Copy it now and store it somewhere safe — a password manager, a secrets vault, or your deployment environment’s secret store.

📸 Screenshot: [Key creation success screen showing the full API key string with a “Copy” button and a warning that the key will not be shown again]

Step 4: Add the Key to Your Authorization Header

Pass your API key in the Authorization header of every request your system makes. Your developer or the tool you are connecting to will handle this. The format is Bearer YOUR_API_KEY.

📸 Screenshot: [Code snippet or API client showing the Authorization header with the Bearer token format]

Step 5: Check Your Rate Limit Tier

Review the rate limits table to confirm how many requests per minute your current plan allows. If you expect high request volume, verify your plan supports it before going live.

📸 Screenshot: [Settings or plan page showing the current plan tier and the corresponding API request rate limit]

Step 6: Test a Request Against the API Reference

Open the interactive API reference and fire a test request — for example, creating a short link — directly from your browser to confirm your key works end-to-end.

Next Steps

• Webhooks — Get notified in real time when links are clicked or changed.
• Retargeting Pixels — Build ad audiences from everyone who clicks your links.
• API Reference → — Full endpoint documentation with interactive examples.