Sign in
Domains

List Domains

get/api/v1/domains/

Query parameters

status'not_started' | 'awaiting_ownership' | 'pending' | 'dns_invalid' | 'verifying' | 'verified' | 'failed' | 'pending_dkim_rotation' | 'degraded' | 'pending_deletion'

Filter to rows in this lifecycle status. Omit to return every row in the org regardless of state. The mailbox-create dropdown reads from ?status=verified.

Response

Successful Response

idstring required
organization_idstring required
domainstring required
mail_from_subdomainstring required
is_defaultboolean required
status'not_started' | 'awaiting_ownership' | 'pending' | 'dns_invalid' | 'verifying' | 'verified' | 'failed' | 'pending_dkim_rotation' | 'degraded' | 'pending_deletion' required
failure_reasonstring nullable required
verified_atstring date-time nullable required
last_checked_atstring date-time nullable required
dkim_selectorstring required
ownership_tokenstring required

Changes