Skip to content
Extrovert Extrovert Docs

Check which domains are ready to use

GET
/v1/domains

List the onboarded domains for the agent’s customer (newest-first, paginated). Lead with readiness.label and readiness.summary; use readiness.ready_for_inboxes to decide whether mail setup is complete. Optional inbox counts are scoped to this agent, not the entire account. Legacy verification and signing flags are diagnostic details, not proof of readiness. The customer/tenant is derived from the agent key.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 100

Page size for the cursor-paginated agent surface (default 50; clamped to the 1-100 range).

page
string

Opaque page token echoed back from a prior next_page. Used by the legacy offset-paginated admin/console list surface; the cursor-paginated agent surface uses Cursor (?cursor) instead.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Ok

A page of domains in the canonical agent-plane envelope.

object
items
Array<object>

The agent-facing view of one domain: its status plus the nameserver records the customer must publish for delegated setup. Records are empty on list reads and for hosted/purchased modes.

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
id
string
domain
string
mode
string
Allowed values: shared ns_delegated manual purchased
verification_status
string
dkim_status
string
shared
boolean
provisioning_phase
string
provisioning_error
string
created_at
string format: date-time
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
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
instruction
string
total
integer
next_cursor
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

403

Section titled “403 ”

Authenticated but lacking the required scope, or out of quota.

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