GET
/
domains

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Query Parameters

archived
boolean
default: false

Whether to include archived domains in the response. Defaults to false if not provided.

search
string

The search term to filter the domains by.

page
number
default: 1

The page number for pagination.

Required range: x > 0
pageSize
number
default: 50

The number of items per page.

Required range: 0 < x < 50

Response

200 - application/json
id
string
required

The unique identifier of the domain.

slug
string
required

The domain name.

verified
boolean
default: falserequired

Whether the domain is verified.

primary
boolean
default: falserequired

Whether the domain is the primary domain for the workspace.

archived
boolean
default: falserequired

Whether the domain is archived.

placeholder
string | null
required

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

expiredUrl
string | null
required

The URL to redirect to when a link under this domain has expired.

notFoundUrl
string | null
required

The URL to redirect to when a link under this domain doesn't exist.

createdAt
string
required

The date the domain was created.

updatedAt
string
required

The date the domain was last updated.

registeredDomain
object | null
required

The registered domain record.