Get Email Sender

Beta

GET/v1/messaging/email-sender

This endpoint is idempotent. Learn more

Returns the address your order, invoice, and statement emails are sent from, or 404 when none is configured and that mail sends from the platform address.

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Email sender ID.

objectstringenumValues:email_sender

Resource type identifier.

email_domain_idstring

The verified email domain this address belongs to.

local_partstring

The mailbox name before the @.

addressstring

The full sending address.

from_namestringnullable

The name shown in a mail client's sender column. When unset, mail shows the bare address.

reply_tostringnullable

Where customer replies are delivered. When unset, replies go to the sending address.

domainstring

The domain name the address sends from.

domain_statusstringenumValues:pendingverifiedfailed

Verification status of the underlying domain.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Get Email Sender

Get Email Sender

import OpenMRP from '@openmrp/sdk';

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

const emailSender = await client.messaging.emailSender.list();

console.log(emailSender.id);

import OpenMRP from '@openmrp/sdk';

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

const emailSender = await client.messaging.emailSender.list();

console.log(emailSender.id);

200 example

{
  "id": "emsx_4bk9pmt2wvqd",
  "object": "email_sender",
  "email_domain_id": "emdom_2rk3omr8vshb",
  "local_part": "orders",
  "address": "orders@support.acme.com",
  "from_name": null,
  "reply_to": null,
  "domain": "support.acme.com",
  "domain_status": "verified",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "emsx_4bk9pmt2wvqd",
  "object": "email_sender",
  "email_domain_id": "emdom_2rk3omr8vshb",
  "local_part": "orders",
  "address": "orders@support.acme.com",
  "from_name": null,
  "reply_to": null,
  "domain": "support.acme.com",
  "domain_status": "verified",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Get Email Sender

Authorization

Returns

Responses