List Email Domains

Beta

GET/v1/messaging/email-domains

This endpoint is idempotent. Learn more

Returns the account's registered email domains.

Every domain is returned in a single response; this list is not paginated.

Permission requiredValues:messaging:read

The role behind your API key or agent must grant this permission.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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).

statusstringenumValues:pendingverifiedfailed

Verification status.

pending: registered and awaiting DKIM confirmation.
verified: DKIM confirmed; the domain can send mail.
failed: verification could not be completed.

Inboxes can only be created on a verified domain.

dkim_tokensarray of string

The DKIM tokens that must be published in your DNS before the domain can be verified.

Publish each token as a CNAME record on the domain, then call the verify action to confirm them.

mail_from_domainstringnullable

The subdomain used as the envelope return path for mail sent from this domain.

Publishing the two records below makes the return path match the sender address. Until you do, mail clients show your mail as coming from your address "via amazonses.com".

mail_from_mx_recordstringnullable

The MX record to publish on mail_from_domain, for delivery of bounces and complaints.

mail_from_spf_recordstringnullable

The SPF record to publish as a TXT record on mail_from_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

List Email Domains

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listEmailDomain = await client.messaging.emailDomains.list();

console.log(listEmailDomain.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listEmailDomain = await client.messaging.emailDomains.list();

console.log(listEmailDomain.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/email-domains?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiZW1kb21fMnJrM29tcjh2c2hiIiwiZCI6ImYifQ.c2kghewMio0yn0qy5jPL1FhpMcJ-oyEi8Lh6usVa6TU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "emdom_2rk3omr8vshb",
      "object": "email_domain",
      "domain": "support.acme.com",
      "status": "pending",
      "dkim_tokens": [
        "abc123._domainkey.support.acme.com",
        "def456._domainkey.support.acme.com"
      ],
      "mail_from_domain": null,
      "mail_from_mx_record": null,
      "mail_from_spf_record": null,
      "verified_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/email-domains?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiZW1kb21fMnJrM29tcjh2c2hiIiwiZCI6ImYifQ.c2kghewMio0yn0qy5jPL1FhpMcJ-oyEi8Lh6usVa6TU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "emdom_2rk3omr8vshb",
      "object": "email_domain",
      "domain": "support.acme.com",
      "status": "pending",
      "dkim_tokens": [
        "abc123._domainkey.support.acme.com",
        "def456._domainkey.support.acme.com"
      ],
      "mail_from_domain": null,
      "mail_from_mx_record": null,
      "mail_from_spf_record": null,
      "verified_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Email Domains

Authorization

Returns

Responses