GET /accounts/{account_id}/email-security/settings/domains

Returns a paginated list of email domains protected by Email Security. Includes domain configuration, delivery modes, and authorization status. Supports filtering by delivery mode and integration ID.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Account identifier tag.

Query parameters

Name Type Required Description
page Integer No

Current page within paginated list of results.

Default value: 1

order String No

Field to sort by.

Valid values:

  • "domain"
  • "created_at"
direction String No

The sorting direction.

Valid values:

  • "desc"
  • "asc"
per_page Integer No

The number of results per page. Maximum value is 1000.

Default value: 20

search String No

Search term for filtering records. Behavior may change.

domain[] Array No

Domain names to filter by.

status String No

Filters response to domains with the provided status.

Valid values:

  • "failed"
  • "active"
  • "timeout"
  • "pending"
active_delivery_mode String No

Currently active delivery mode to filter by.

Valid values:

  • "JOURNAL"
  • "RETRO_SCAN"
  • "DIRECT"
  • "API"
  • "BCC"
integration_id String No

Integration ID to filter by.

allowed_delivery_mode String No

Delivery mode to filter by.

Valid values:

  • "JOURNAL"
  • "RETRO_SCAN"
  • "DIRECT"
  • "API"
  • "BCC"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.