Listing your domains

You can access your branded domains collection at any time with an HTTP GET on the branded domains endpoint

We recommend you have deep comprehension about how our API manages Pagination and Sorting.

If you want to get only branded domains matching a given set of conditions, you can attach filters to your request:


Parameter nameTypeConstraintsDescription
orderBystring enum

- createdAt
- updatedAt
- fullNameSee Sorting
optionalSorting criteria to apply to your branded domains collection
orderDirstring enum

- desc
- ascSee Sorting
optionalSorting direction to apply to your branded domains collection

See Pagination
optionalThe id of the last domain you fetched in the last listing API call
default is 25

See Pagination
Strictly positive
Max 25
How many branded domains to load
activebooleanoptionalFilter branded domains depending on whether they can be used to brand short links or not
typestring enum

- user
- service
optionalFilter branded domains depending on their type (owned by user or service domains like
GETting branded domains collection
$ curl '' \
-H 'apikey: YOUR_API_KEY'
JSON response (list of domains matching filters)
    "id": "4d20ec31db1e48c5aded19e93f137a11",
    "fullName": "",
    "topLevelDomain": "cool",
    "createdAt": "2016-07-01T13:12:22.000Z",
    "updatedAt": "2016-07-03T13:17:50.000Z",
    "type": "user",
    "active": false
  // up to 100 active user branded domains

Handling errors

HTTP StatusError typeDescription
403403 - Invalid formatInvalid query parameters format. Double check value for property query parameter. Details about validation failure in message field.