List Email Domains
BetaGET
/v1/messaging/email-domainsThis endpoint is idempotent. Learn more
Returns the account's registered email domains.
Permissions requiredValues:messaging:read
The role behind your API key or agent must grant every one of these permissions.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of email_domainResources in this page.
idstringEmail domain ID.
objectstringenumValues:email_domainResource type identifier.
domainstringThe fully-qualified domain name (e.g. support.acme.com).
statusstringVerification status.
pending: registered and awaiting DKIM confirmation.verified: DKIM confirmed; the domain can send and receive mail.failed: verification could not be completed.
dkim_tokensarray of stringThe DKIM CNAME tokens the customer must publish in DNS to verify the domain.
verified_atstring (date-time)nullableWhen the domain's DKIM verification was confirmed.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
200
Successful response for List Email Domains