List Suppressed Contacts
POST/v1/suppression/list
Retrieve a paginated list of all contacts in your suppression list.
Request Body
| Field | Type | Description | Required |
|---|---|---|---|
page | integer | Page number (1-indexed) | ❌ No (default: 1) |
page_size | integer | Number 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 Code | Message | Description |
|---|---|---|
| 400 | Invalid Request | Verify your request is properly formatted |
| 401 | Unauthorized | Verify you are using a valid API key |
| 500 | Internal Server Error | An unexpected error occurred. |
Request
Responses
- 200
Successful response