List Email Domains

Beta
GET/v1/messaging/email-domains

This 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:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of email_domain

Resources in this page.

idstring

Email domain ID.

objectstringenumValues:email_domain

Resource type identifier.

domainstring

The fully-qualified domain name (e.g. support.acme.com).

statusstring

Verification 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 string

The DKIM CNAME tokens the customer must publish in DNS to verify the domain.

verified_atstring (date-time)nullable

When 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