The API is organized around the following resources:
Get info about your own account.
Manage your workspaces collection. Each workspace can host links, domains, tags and scripts and you can invite teammates to collaborate in workspaces.
Manage all branded domains shared into the workspace.
Manage your branded short links collection.
Manage a collection of tags you can attach to your links in the context of a specific 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:
Generic Rebrandly API model
A Domain object
String with format:
array of string
Floating point number
The API also uses common approaches for the following:
All responses are in JSON format, encoded with utf-8.
A response can be an object, a list of objects, or a primitive value.
All endpoints are protected with OAuth 2.0 Bearer token or with API key authorization
Methods are used in accordance with HTTP (GET POST, PATCH and DELETE are the only methods used) and resources are identified using URIs.
HTTP 200 responses returning JSON objects
HTTP 403 responses with JSON validation info
HTTP 401 response
API rate exceeded
HTTP 429 response
HTTP 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.