Email address tools

Inspect your organization’s email addresses by ID or list them with filters.

Address purpose fields

Both tools return these fields on each email address:

Field	Values	Meaning
`purpose`	`general`, `transactional`, `marketing`	The address’s intended use. Defaults to `general`.
`domainPurpose`	`general`, `transactional`, `marketing`, `null`	The linked domain’s purpose, or `null` when no domain is linked. Follows changes to that domain’s purpose.

Marketing addresses require a marketing domain when created or reassigned. Deleted addresses do not prevent changing a domain’s purpose. General and transactional addresses can use domains of any purpose. If a linked domain is permanently deleted, domainId and domainPurpose become null, while purpose stays unchanged. A detached address cannot send through that domain. These tools only read addresses; they do not set either purpose field. Changing a domain’s purpose triggers an email-address update event for each linked address that has not been deleted, so your email-address automations can respond to the new domainPurpose. Each affected address’s updatedAt reflects the change. API and MCP credentials need email-addresses:read as well as domain write permission to change a domain’s purpose.

getEmailAddress

Get details of a specific email address by ID. Permission: email-addresses:read Parameters:

Name	Type	Required	Description
`emailAddressId`	string (UUID)	Yes	The ID of the email address to retrieve

Returns: The email address object, or null if not found.

listEmailAddresses

List email addresses for the organization with optional filtering. Permission: email-addresses:read Parameters:

Name	Type	Required	Default	Description
`limit`	number	No	100	Maximum number of results
`offset`	number	No	0	Offset for pagination
`provider`	string	No	-	Filter by email provider. Valid values: `google`, `microsoft`, `bizzy`, `apple`
`status`	string	No	-	Filter by email address status. Valid values: `pending`, `active`, `disabled`, `errored`, `deleted`

Returns:

{
  "emailAddresses": [...],
  "count": 12,
  "limit": 100,
  "offset": 0
}

Getting Started

Agent resources

Address purpose fields

getEmailAddress

listEmailAddresses

Next steps

Email template tools

Authentication

​Address purpose fields

​getEmailAddress

​listEmailAddresses

​Next steps

Email template tools

Authentication

Address purpose fields

getEmailAddress

listEmailAddresses

Next steps