API Documentation
Support

Get started

Make your first API call and create a branded short link in minutes

Make your first Rebrandly API call and create a working branded short link in three steps.

Before you begin

You need:

  • A Rebrandly account. Sign up for free if you haven't yet.
  • An API key. Generate one in Rebrandly under Settings > API keys.

Step 1: Make your first request

Verify your API key works by fetching your account details.

curl -X GET \
  https://api.rebrandly.com/v1/account \
  -H 'apikey: YOUR_API_KEY'

A successful response returns your account object:

{
  "id": "a1b2c3d4e5f6",
  "fullName": "Maria Rossi",
  "email": "[email protected]",
  "createdAt": "2026-01-01T00:00:00.000Z"
}
📘

Check your limits here

The account response includes your plan's resource limits and enabled features. It's a useful first call in any integration to confirm what your API key can do.

Step 2: Create a branded short link

Send a POST request to /v1/links with a destination URL.

curl -X POST \
  https://api.rebrandly.com/v1/links \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination": "https://www.brandyour.link",
    "title": "My first branded link"
  }'

Because the request doesn't include a slashtag, Rebrandly generates one automatically. A successful response returns the created link object:

{
  "id": "m5jk4cc5bjop45d6",
  "title": "My first branded link",
  "slashtag": "abc123",
  "destination": "https://www.brandyour.link",
  "shortUrl": "rebrand.ly/abc123",
  "domain": {
    "id": "8f104cc5b6ee4a4ba7897b06ac2ddcfb",
    "fullName": "rebrand.ly"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

The shortUrl field is your new branded link. It's live immediately.

📘

Using your own domain

The example above uses rebrand.ly, the default domain available on every account. To create links under your own branded domain, include a domain.id in your request body. Retrieve your domain IDs from GET /v1/domains.

Step 3: Test your link

Open https:// followed by your shortUrl value in a browser (for example, https://rebrand.ly/abc123). You'll be redirected to your destination URL.

Next steps