Sign in
Domains API

Search a single domain availability and price

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

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

namestring required
Example:mysite.org

The fully-qualified domain name to check availability and price for

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

namestring

The name of the domain

availableboolean

Whether the domain is available for registration

premiumboolean

Whether the domain is a premium domain with higher pricing

Example response

{
  "name": "example.com"
}

Changes

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

  • fa785a68f09d2See the full diff
    • ○

      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