Skip to content
Extrovert Extrovert Docs

Get one domain's detail and nameserver records

GET
/v1/admin/orgs/{org_id}/projects/{project_id}/domains/{domain}

Read one onboarded domain the caller’s org owns, including the DNS nameserver records the customer must publish for ns_delegated mode. The list endpoint omits records to stay lightweight, so the console reads this when a domain row is expanded so the delegation reappears after the onboarding dialog is dismissed or the page reloaded. Tenant-scoped: an unknown domain, or one owned by a different org, is a 404 (records are never leaked across tenants).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string
project_id
required
string
domain
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The domain detail with delegation_ns inline.

object
readiness

Authoritative domain outcome shared by the console, API, MCP and SDK. Show summary and next_action instead of interpreting verification_status, mode or dkim_status. ready_for_inboxes describes domain configuration only; creating an inbox still requires permission and available plan capacity. checked_at is the latest DNS observation, not an end-to-end mail test.

object
status
required
string
Allowed values: waiting_for_dns checking setting_up ready action_required needs_attention
label
required
string
summary
required
string
reason
required
string
action_required_by
required
string
Allowed values: customer extrovert none
next_action
required
string
Allowed values: check_dns_entries restore_dns wait create_inbox use_inbox ask_owner_to_create_inbox
ready_for_inboxes
required
boolean
checked_at
string format: date-time
next_check_at
string format: date-time
poll_after_seconds
required
integer
>= 1
inboxes

Omitted without inbox-read permission. Agent counts include only that agent’s visible inboxes.

object
scope
required
string
Allowed values: agent inbox selected_inboxes project organization
total
required
integer
ready
required
integer
setting_up
required
integer
needs_attention
required
integer
delegation

Customer nameserver health, independent of mail setup. Confirmed DNS is not mail readiness. Action required means restore the instructed nameservers; mail may be disrupted.

object
status
string
Allowed values: pending confirmed rechecking check_delayed action_required
checked_at
string format: date-time
confirmed_at
string format: date-time
domain
string
mode
string
Allowed values: shared ns_delegated manual purchased
verification_status
string
zone_id
string
provisioning_phase
string
provisioning_error
string
delegation_ns
Array<object>

A DNS record the customer must add for domain onboarding.

object
name
string
type
string
Example
TXT
value
string
priority
integer
nullable
ttl
integer
records
Array<object>

A DNS record the customer must add for domain onboarding.

object
name
string
type
string
Example
TXT
value
string
priority
integer
nullable
ttl
integer
instruction
string

401

Section titled “401 ”

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

404

Section titled “404 ”

Resource not found.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean