Domains
Retrieve a domain
Retrieve the complete public state and redirect configuration for one custom domain.
GET
Retrieve a domain
Retrieve one domain attached to the API key’s workspace.
Authentication and permission
Requires Custom domains: Read (custom_domains.view). Only a public
biq_dom_... ID is accepted; numeric IDs and hosts are not path identifiers.
Response
200 OK returns the complete safe domain resource:
links_count includes only links in the API key’s workspace, even when the
same verified domain is attached to another workspace.
The response never exposes numeric user/workspace IDs, verification internals,
raw DNS lookup results, SSL errors, or cleanup state. Use
Retrieve DNS configuration for the exact
records the owner must publish.
Malformed, deleted, or cross-workspace IDs all return the same
404 resource_not_found response to prevent resource disclosure.
Shared API behavior
Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.Authorizations
A workspace API key beginning with biqli_.
Path Parameters
Public custom-domain ID. Numeric IDs and hosts are not accepted.
Pattern:
^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
