Skip to main content

List the email domains claimed by the organization​

Returns every email domain the organization has claimed, pending and verified alike, with the DNS TXT challenge of each pending claim.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • code string

    Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

  • result object[]
  • organization_id string
  • domain string

    The domain in canonical form (lowercase, ASCII)

  • status string

    Possible values: [pending, verified]

    Verification state of an email domain ownership claim

  • verification_method string

    Possible values: [dns_txt, manual]

    How ownership of the email domain was established

  • txt_record object

    The DNS TXT record that proves ownership of the domain

  • name string
  • value string
  • verified_at date-time
  • verified_by string

    ID of the super-admin who verified the domain manually, when applicable

  • created_at date-time
  • last_updated date-time