MYmyclickfunnels
Emails::Address

List Email Addresses

Changed on

List all email addresses for a workspace. See Addresses (pick a usable sender) in the Emails Skill for picking one to send from.

get/workspaces/{workspace_id}/emails/addresses

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

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

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More 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 has verified email transport. This is NOT the same as usable: transport verification says nothing about domain ownership, so always pick a sender by the top-level usable_as_sender field rather than by this filter. When false, returns only addresses without a transport-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

OK

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 address is on the shared ClickFunnels sending domain (the workspace default). A workspace-default address is usable as a sender only as a fallback: once the workspace has a usable custom sender of its own, its workspace-default address reports usable_as_sender: false. So is_workspace_default: true together with usable_as_sender: false is expected whenever the workspace already has a usable custom sender.

usable_as_senderboolean

Whether this address is eligible to be used as the from sender of an email broadcast. A custom-domain address is usable once its sending domain is verified (DKIM/SPF/DMARC or a verified SMTP setting) and the workspace owns that domain. A workspace-default (shared-domain) address is usable only as a fallback - it is true when the workspace has no usable custom sender of its own and flips to false once one exists. Filter broadcast senders to addresses where this is true to avoid a broadcast failing validation at send time. See Addresses (pick a usable sender) in the Emails Skill.

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"
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status