v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB

Suppression APIs

List Suppressed Emails

Retrieves a paginated list of domains currently added to the suppression list. You can apply optional filters such as start and end date, and use pagination parameters to control result size and navigation. This is useful for auditing or managing domains that are blocked from receiving emails.

get/suppressions/global/email

Query parameters

start_timestring date

Example:2022-02-10

Optional filter to return domains suppressed on or after this date. Format is YYYY-MM-DD. It is applicable for modified date only.

end_timestring date

Example:2022-03-10

Optional filter to return domains suppressed on or before this date. Must be equal to or later than start_time. Format is YYYY-MM-DD. It is applicable for modified date only.

offsetinteger

Example:5

Number of records to skip for pagination. Minimum: 0. Default: 0.

limitinteger

Example:10

Number of records to return in the response. Range: 1–1000. Default: 1000.

Headers

on_behalf_ofstring

Example:subaccount_username

(Optional) Use this header when making API calls on behalf of a subaccount. Required only if you’re using a master account’s API key.

Response

List of suppressed domains retrieved successfully.

emailstring required

createdstring date-time required

modifiedstring date-time required

statusinteger required