Rebrandly for Developers

Use our API to create, track and share custom short links that incorporate your brand domain name.

Get Started

Getting domain details

Each Domain object has its own URL:{id}, where {id} is the unique identifier of the branded domain.
To get Domain object details, you should HTTP GET on the specific domain endpoint, and a JSON object representing the domain will be returned.


Path parameter


Unique identifier of the branded domain you want to get details about

GETting Domain details

$ curl '' \
-H 'apikey: YOUR_API_KEY'

JSON Response (Domain details)

  "id": "4d20ec31db1e48c5aded19e93f137a11",
  "fullName": "",
  "topLevelDomain": "cool",
  "createdAt": "2016-07-01T13:12:22.000Z",
  "updatedAt": "2016-07-03T13:17:50.000Z",
  "type": "user",
  "active": false

Handling errors

HTTP Status
Error type


Given id does not correspond to any existing domain

Getting domain details

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.