Get whitelist suppressions

GET

/api/domains/{domain}/suppressions/whitelist

• Application server

Retrieve a paginated list of whitelist suppressions for a domain

Authorizations

• basicAuth

Parameters

Path Parameters

domain

required

string

Example

example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Query Parameters

search

string

Search suppressions by recipient

page

integer

default: 1 >= 1

Page number

per_page

integer

default: 10 >= 10 <= 100

Number of items per page

Responses

200

Success

object

success

boolean

Example

true

data

Array<object>

Suppression entry

object

id

integer

Example

1

type

string

Allowed values: unsubscribe bounce whitelist

Example

unsubscribe

recipient_type

string

Allowed values: email domain

Example

email

recipient

string

Example

[email protected]

tags

string

nullable

Example

marketing

description

string

nullable

Example

Opted out from newsletter

source

string

nullable

Example

api

created_at

integer

Example

1711234567

pagination

object

filters

object

401

Unauthorized - Invalid or missing authentication credentials

object

success

boolean

message

string

Example

Unauthorized

404

Not Found - Domain not found

object

success

boolean

message

string

Example

Domain not found

429

Too Many Requests - Rate limit exceeded. Retry after the specified time.

object

success

boolean

message

string

Example

Too many attempts. Please try again later.

Headers

Retry-After

integer

Seconds until rate limit resets

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window