List the customer's domains and their status

GET

/v1/domains

• Production
• Local

List the onboarded domains for the agent’s customer (newest-first, paginated), each with its onboarding mode and verification/DKIM status. The customer/tenant is derived from the agent key.

Authorizations

• AgentKey
  domain:manage

Parameters

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

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

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

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

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