Skip to main content
GET
/
v1
/
public
/
accounts
/
{account_id}
/
domains
/
{domain}
Get Domain
curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "outbound_routing_ready": true,
  "status": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_renew": false,
  "created_at": "<string>",
  "dedicated_ip_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_records": [
    {
      "id": 123,
      "name": "<string>",
      "ttl": 123,
      "type": "<string>",
      "value": "<string>",
      "is_system_managed": false,
      "priority": 123
    }
  ],
  "inbound_tenant_external_id": "<string>",
  "inbound_tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_tenant_name": "<string>",
  "inbound_tenant_type": "<string>",
  "mailboxes": [
    {
      "active": true,
      "email": "<string>",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>"
    }
  ],
  "redirect_url": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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