GET
Get Domain

Authorizations

Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

account_id
string<uuid>
required
domain
string
required

Response

id
string<uuid>
required

Domain UUID

name
string
required

Domain name

outbound_routing_ready
boolean
required

Whether outbound routing is ready

status
string
required

Domain lifecycle status

workspace_id
string<uuid>
required

Workspace UUID that contains the domain

auto_renew
boolean
default:false

Whether domain auto-renewal is enabled

created_at
string | null

Domain creation timestamp

dedicated_ip_id
string<uuid> | null

Assigned dedicated IP UUID, if any

dns_records
DomainDnsRecordResponse · object[]

DNS records for the domain

inbound_tenant_external_id
string | null

Provider external ID for the inbound tenant

inbound_tenant_id
string<uuid> | null

Inbound tenant UUID, if assigned

inbound_tenant_name
string | null

Inbound tenant display name, if assigned

inbound_tenant_type
string | null

Inbound tenant type, if assigned

mailboxes
DomainMailboxSummary · object[]

Mailboxes on the domain

redirect_mode
enum<string> | null

Configured redirect mode, if any

Available options:
301,
302,
iframe
redirect_url
string | null

Configured redirect URL, if any

tags
DomainTagResponse · object[]

Tags attached to the domain

updated_at
string | null

Domain last update timestamp