Domains API

Check claimable domains availability for a subdomain name

get/workspaces/{workspace_domain}/domains/claimable/{name}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

namestring required
Example:food

The subdomain name to search for in the list of claimable domains

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

Changes

Changed in 1 of the 8 revisions of this API.2

    • the security scope DOMAIN_READ was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope ZONE_READ was removed from the endpoint's security scheme oauth2

      api-security-scope-removed