Skip to main content
GET
Retrieve a list of domains

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

domains
string[]

Domains to filter by. eg. domains=domain1&domains=domain2

The search term to filter the domains by.

Required string length: 1 - 190
showArchived
boolean
default:false

Whether to include archived domains in the response.

page
integer<int32>
default:1

The page number for pagination.

pageSize
integer<int32>
default:20

The number of domains per page.

Required range: 1 <= x <= 50
sortBy
enum<string>

The field to sort the domains by.

Available options:
created_at,
domain
sortOrder
enum<string>
default:desc

The order to sort the domains by.

Available options:
desc,
asc

Response

slug
string
required
destination
string
required
clicks
integer
required
cnameStatus
string
required
sslStatus
string
required
expiredUrl
string
notFoundUrl
string
appleAppSiteAssociation
string