v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Emails::Address

List Email Addresses

List all email addresses for a workspace

get/workspaces/{workspace_id}/emails/addresses

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

email_addressstring

Exact match on the email address.

verifiedboolean

When true, returns only addresses whose sending domain is verified (usable senders). When false, returns only addresses without a verified sending domain (including shared-domain addresses). Omit to return all addresses.

Filter by available properties in query params, like this: api/v2/resources?filter[email_address]=value&filter[verified]=true. Check our Filtering guide for examples and all about filtering here.

{
  "email_address": "marketing@example.com"
}

Response

idinteger

Address ID

public_idstring nullable

Address public ID

workspace_idinteger

Workspace ID

email_addressstring

Email address

namestring nullable

Display name associated with this email address

is_workspace_defaultboolean

Whether this is the workspace's default email address

usable_as_senderboolean

Whether this address is eligible to be used as the from sender of an email broadcast. True when it is on a verified sending domain (verified ownership + DNS), has a custom SMTP setting, or — when the workspace has no verified sender of its own — is on the shared sending domain. Filter broadcast senders to addresses where this is true to avoid a broadcast failing validation at send time.

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

[
  {
    "id": 1,
    "public_id": "AbCdEf",
    "workspace_id": 42000,
    "email_address": "marketing@example.com",
    "name": "Marketing Team",
    "is_workspace_default": false,
    "usable_as_sender": true,
    "emails_domain": {
      "name": "example.com",
      "verified": true,
      "dkim_verified": true,
      "spf_verified": true,
      "dmarc_verified": true,
      "smtp_verified": false
    },
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]