Skip to main content
GET
Check domain availability
Required scopes: accounts--my:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Query Parameters

name
string
required

Domain name prefix to check - <name>.helpdesk.com will be checked.

Response

200 - application/json

Successful response.

available
boolean

Is domain available