Domains matching a keyword (or one exact domain), with availability, whether Google Workspace and Microsoft 365 can host each, and the first-year price. Needs the managed mailboxes feature on the workspace (403, code: feature-disabled).
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Query Parameters
A word (acme) or an exact domain (getacme.com).
Comma-separated endings to search, e.g. .com,.co.
1 <= value <= 101Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/domains/search?keyword=string"{ "data": [ { "name": "string", "available": true, "premium": true, "priceCents": 0, "renewalCents": 0, "platforms": { "google": true, "microsoft": true } } ]}Price an order POST
Price domains and mailboxes before buying: the lines charged now (domain registration, the first month) and every month after, in cents. Returns a `quoteId`, valid for 30 minutes, that POST /mailbox-orders needs. Charges nothing. Domains no longer available are listed in `unavailable`. Needs the managed mailboxes feature (`403`). A domain entry with `existing: true` adds mailboxes to a domain the workspace already bought (GET /managed-domains): no domain charge, only the mailboxes, which are usually ready within minutes. Addresses already taken on such a domain are listed in `unavailableMailboxes`. Refusals: `404` `domain-not-owned`, `409` `domain-full` (`details.slotsLeft`), `409` `domain-admin-cancelled` (its admin mailbox was cancelled, so it takes no new mailbox). `contact` is only required when the order registers a new domain.
Create a workspace POST
Creates a workspace inside the connected organization. Optionally grant it seats from the organization pool with `seatAllocation`. Allocating more than the pool has available is rejected with `400`, unless the organization's seats are added on demand (pay as you go): then the missing seats are added to the subscription instead. Requires the connected workspace to be an organization (otherwise `403`).