List verified domain rows

Identity module

GET/verified-domainsverifiedDomains.list

A verified email domain with automatic join and a default role. Returns a cursor page of verified domain rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability org.settings.read.
OAuth scopes: org.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

verifiedDomains.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of VerifiedDomain

verifiedDomains.list: VerifiedDomain
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the verified domain.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
hostname	string	Yes	Lowercase host name, for example gateway.northwindlive.example.Constraints: length 1 to 253
purpose	"Atlas" \| "Gateway" \| "Email Sending" \| "Verified Domain"	Yes	What the domain is for.
verification_state	"Pending" \| "Verified" \| "Failed"	Yes	DNS verification state; changed only by app.record_domain_verification.
verification_token	string	Yes	Value the org publishes in a DNS TXT record to prove control.Constraints: length 1 to 300
last_checked_at	string (date-time) \| null	Yes	When the verification service last checked DNS.
auto_join_role_id	string (uuid) \| null	Yes	Identifier of the role a person with a confirmed address at this verified domain receives on joining automatically; null turns automatic join off.
provisioning_status	"Not Started" \| "Requested" \| "Pending DNS" \| "Active" \| "Failed" \| "Released"	Yes	Where the domain stands at its provider.
dns_records	array of DomainDnsRecord	Yes	DNS records to publish for the provider.
tls_ready	boolean	Yes	True once the provider issued the TLS certificate.
provisioning_error	string \| null	Yes	Why the latest provisioning step failed.Constraints: length 1 to 2000

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "hostname": "gateway.northwindlive.example",
      "purpose": "Atlas",
      "verification_state": "Pending",
      "verification_token": "xos-verify=6f1c2d",
      "last_checked_at": "2026-10-08T14:30:00Z",
      "auto_join_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "provisioning_status": "Pending DNS",
      "dns_records": [
        {
          "type": "CNAME",
          "name": "atlas.northwindlive.example",
          "value": "cname.vercel-dns.com",
          "purpose": "routing"
        }
      ],
      "tls_ready": false,
      "provisioning_error": "Vercel returned 400"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/verified-domains" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.verifiedDomains.listAll()) {
  console.log(row);
}

for row in xos.verified_domains.list_all():
    print(row)

xos verified-domains list --all