API reference

API reference · Organizations

A crew's email domains

GET/api/orgs/{id}/domainsSigned in session

members.manage. Each claim with the TXT record that proves it, whether email proof is available here, and the admin mailboxes a proof link may go to.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredintegerThe crew's id.

Answer 200

The domains.

Fields of the 200 answer
FieldTypeWhat it is
domainsarray of object
domains[].idinteger
domains[].domainstring
domains[].verifiedAtinteger or null
domains[].verifiedMethodstring or nullOne of "dns", "email", null.
domains[].autoApproveboolean
domains[].createdAtinteger
domains[].lastCheckedAtinteger or null
domains[].dnsobject
domains[].dns.hoststring
domains[].dns.type"TXT"
domains[].dns.valuestring
domains[].emailPendingTostring or null
domains[].verifiedUntilinteger or nullWhen an email proof lapses (it lasts 30 days); null for DNS, which does not.
emailboolean
mailboxesarray of string

Errors

  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter