Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/search \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "query": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Checks availability + price for candidate names and returns a signed **availability token** for each name that is available in a TLD we offer. The token is what a `domain_register` cart line carries; checkout re-verifies it (a stale/taken one → `409`, no charge) — so registration/transfer happen through the cart/checkout flow, and this is the "find one to buy" half. A dotted `query` is checked as one exact FQDN; a bare name is checked across the requested `tlds` (or every offered TLD when none are given). Rate-limited. Requires `sites.view`.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
query | string | Yes | A bare name (`acme`) checked across `tlds`, or a full FQDN (`acme.com`). |
tlds | string[] | No | TLDs to check a bare name against. Ignored for a dotted query. Omitted, a bare name expands to the catalogue's most popular extensions — the top ten on the public endpoint and t… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
results | DomainSearchResult[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429