Model overview

The API is organized around the following resources:

ModelBase endpoint (/v1)Description
all workspaces
Get info about your own account.
all workspaces
Manage your workspaces collection. Each workspace can host links, domains, tags and scripts and you can invite teammates to collaborate in workspaces.
in workspace
Manage all branded domains shared into the workspace.
in workspace
Manage your branded short links collection.
in workspace
Manage a collection of tags you can attach to your links in the context of a specific workspace.
in workspace
Manage a collection of retargeting scripts you can attach to your links in the context of a specific workspace.

All endpoints return responses in JSON format.


Types in objects are defined as follow:

Type nameType descriptionExample
objectGeneric Rebrandly API modelA Domain object
stringUTF8 string"foo"
integer64-bit integer42
timestampString with format:
array of stringCSV string"desc,asc"
decimalFloating point number3.4

General approaches

The API also uses common approaches for the following:

Response dataAll responses are in JSON format, encoded with utf-8.
A response can be an object, a list of objects, or a primitive value.
Authorization layerAll endpoints are protected with OAuth 2.0 Bearer token or with API key authorization
HTTP/HTTPSMethods are used in accordance with HTTP (GET POST, PATCH and DELETE are the only methods used) and resources are identified using URIs.
Successful operationHTTP 200 responses returning JSON objects
Invalid operationHTTP 403 responses with JSON validation info
Unauthorized operationHTTP 401 response
API rate exceededHTTP 429 response
Server errorHTTP 50x response with JSON details


IMPORTANT: use HTTPS only connection

Despite Rebrandly API still accepts incoming HTTP requests, there are plans to discontinue the HTTP access totally. Make sure that your script leverage an HTTPS connection with API.