Skip to main content
GET
/
contacts
/
suppressed
List all suppressed contacts or domains
curl --request GET \
  --url https://api.getfernand.com/contacts/suppressed \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "email": "spam@hooli.com",
    "created": "2024-01-15T10:30:00Z",
    "blocked": 5,
    "is_common": true
  }
]
Retrieves a list of all suppressed email addresses and domains within the organization. Results can be sorted by contact/domain, blocked count, or creation date in ascending or descending order. Suppressed entries prevent emails from being received from those addresses or domains.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Query Parameters

​
order_by
enum<string>
default:created

Field to order results by. "contact" orders by domain name.

Available options:
contact,
blocked,
created
​
way
enum<string>
default:asc

Sort direction for the results.

Available options:
asc,
desc

Response

List of suppressed contacts retrieved successfully.

​
id
integer<int64>

Unique identifier for the suppression record

Example:

123

​
email
string

Suppressed email address or domain pattern (e.g., "*@domain.com")

Example:

"spam@hooli.com"

​
created
string<date-time>

Timestamp when the suppression was created (UTC)

Example:

"2024-01-15T10:30:00Z"

​
blocked
integer

Number of times emails to this address/domain have been blocked

Example:

5

​
is_common
boolean

Whether this is a common webmail domain (true) or a company domain (false)

Example:

true