INinkbox
Domains

List Domains

Changed on
get/api/v1/domains/

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/domains/
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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

  • 77c7e3ee70cfRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status

  • a0729c3c4a0bRevision changes
    • info

      added subschema #1 to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status