Retrieve a custom domain and its status
GET /v1/custom_domains/{custom_domain}: Retrieve a custom domain and its status.
GET /
- Scope
custom_domains:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”custom_domainstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK CustomDomain
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/custom_domains/cdom_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/custom_domains/cdom_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/custom_domains/cdom_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "id": "cdom_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "custom_domain", "type": "portal", "hostname": "acme.com", "state": "pending", "dns_records": [ { "type": "CNAME", "name": "Acme Corp", "value": "enterprise" } ], "created_at": "2026-01-15T09:30:00Z"}