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

Lists, searches, and sorts an account’s email domains.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Query parameters

Name Type Required Description
page Integer No

The page number of paginated results.

Default value: 1

order String No

The field to sort by.

Possible values:

  • "domain"
  • "created_at"
direction String No

The sorting direction.

Possible values:

  • "desc"
  • "asc"
per_page Integer No

The number of results per page.

Default value: 20

search String No

Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future.

domain[] Array No

Filters results by the provided domains, allowing for multiple occurrences.

active_delivery_mode String No

Filters response to domains with the currently active delivery mode.

Possible values:

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

Filters response to domains with the provided delivery mode.

Possible 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.