Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Email Sender

emailSender.list

Beta

This endpoint is in beta and may not be available for all organizations.

Lists the email addresses available to the acting identity for sending email through Ashby. Each result identifies whether the address is primary, a personal alias, an organization alias, or a no-reply address available across the organization's brands. Individual sending endpoints may support only a subset of these sender types. In particular, sequence.add always rejects NoReply senders; listing an address here does not mean that endpoint accepts it.

Without an X-On-Behalf-Of header, the acting identity is the API service user, which generally has access to organization-wide and no-reply addresses. Use X-On-Behalf-Of to discover the personal addresses available to a specific user.

Requires the sourcingRead permission.

post/emailSender.list

Request body

EmailSenderListRequest required

Response

Responses from the emailSender.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "email": "recruiting@example.com",
      "displayName": "Example Recruiting",
      "type": "OrganizationAlias"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}