domains

GET /v1/domains/{domainId}

Get a domain.

All domains endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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 GET https://api.zinndigital.com/v1/domains/{domainId} \
  -H "Authorization: Bearer zdk_live_…"

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

Returns one domain the caller can view. RBAC + RLS scoped.

Parameters

NameTypeRequiredWhat it is
domainId (path)UuidYesThe domain's id.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnHostnameYesA fully-qualified DNS hostname, lowercase, no trailing dot.
sldstringYes
tldstringYes
product_linestringNoThe product line this domain was created on. **Not decoration** — it is what decides whether the shared fleet A/AAAA records are hidden from the customer (register #93), so the…
ownership_modestring<registered, connected, transferring_in>Yes
statusDomainStatusYesA domain's lifecycle state (docs/31 §4.10).
registered_atobjectNo
expires_atobjectNo
auto_renewbooleanYes
renew_yearsintegerYes
registrar_lockbooleanNo
privacy_enabledbooleanNo
nameserversstring[]Yes
dnssec_enabledbooleanNo
site_idUuid | nullNoThe site this domain points at, if any.
created_atstringYes
updated_atstringNo

Errors this endpoint can return

401 · 403 · 404 · 429