API Documentation
Support

Introduction to the Rebrandly API

What the Rebrandly API is, how it works, and where to start.

The Rebrandly API is a REST API for creating and managing branded short links programmatically. Use it to integrate link branding into your application, automate link creation at scale, or build workflows around click analytics and traffic routing.

Base URL

Core API requests are made over HTTPS to:

https://api.rebrandly.com/v1

Some features use different base URLs — for example, the high-volume link creation API uses https://enterprise-api.rebrandly.com/v1.

Authentication

Every request requires authentication via an API key or OAuth 2.0 Bearer token, typically passed as a request header. See Authentication overview for details.

Resources

The API is organized around these core resources:

ResourceEndpointDescription
Account/accountYour account identity and plan details
Workspaces/workspacesOrganizational containers for links, domains, tags, and scripts
Links/linksBranded short links
Domains/domainsBranded domains connected to your account
Tags/tagsLabels for organizing and filtering links
Scripts/scriptsRetargeting pixels attached to links

For a full breakdown of each resource's properties, see Model overview.

Requests and responses

The API uses standard HTTP methods, with one Rebrandly-specific convention: most updates use POST rather than PUT or PATCH. PUT is used for batch creation on the high-volume API.

  • GET to retrieve resources
  • POST to create resources
  • POST to update resources (for example, POST /links/{id}, POST /scripts/{id})
  • PUT for batch creation (high-volume API only)
  • DELETE to delete resources

All request bodies and responses use JSON. Successful operations return HTTP 200 with a JSON object or array. Errors return the appropriate HTTP status code with a JSON error body. See HTTP responses for the full list.

What you can build

  • Create and update branded short links from your application or CI pipeline
  • Route mobile users to app store listings using native routing
  • Append UTM parameters and tracking tags automatically with URL query parameters
  • Attach retargeting pixels to links for ad audience building
  • Analyze click traffic via the Clickstream

What the API doesn't cover

Some account management tasks are only available in the Rebrandly dashboard:

  • Purchasing or registering branded domains
  • Managing billing and invoicing
  • Managing workspace members and permissions

Where to go next