Skip to main content

List Suppressed Contacts

POST 

/v1/suppression/list

Retrieve a paginated list of all contacts in your suppression list.

Request Body

FieldTypeDescriptionRequired
pageintegerPage number (1-indexed)❌ No (default: 1)
page_sizeintegerNumber of contacts per page (max: 1000)❌ No (default: 100)

Example Request (JSON)

{
"page": 1,
"page_size": 50
}


Response

The response returns a paginated list of suppressed contacts.

Example Success Response

{
"contacts": [
{
"email": "donotcontact@example.com",
"phone_number": "+1234567890",
"linkedin_url": "https://linkedin.com/in/suppressed-user"
}
],
"total_count": 1,
"page": 1,
"page_size": 50
}


Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error CodeMessageDescription
400Invalid RequestVerify your request is properly formatted
401UnauthorizedVerify you are using a valid API key
500Internal Server ErrorAn unexpected error occurred.

Request

Responses

Successful response