Skip to main content
GET
Check domain availability

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app you're finding a domain for.

Query Parameters

domain
string
required

Domain to check, such as example.com.

Response

Successful Response

Whether a domain can be registered, with similar domains that can.

query
string
required

The domain you asked about, normalized to lower case.

Example:

"nordwind-furniture.com"

results
DomainAvailabilityCheckResult · object[]
required

The domain you asked about, first, followed by up to five suggestions.