List Suppressions

Retrieve the suppressions stored for your workspace. Results are paginated and include the suppression ID, email address, suppression type, and creation timestamp.

Query Options

Filtering, searching, sorting, and pagination supported by the list endpoint

  • Use search to match suppression email addresses.
  • Use filters[] to filter by supported fields. The developer suppressions list currently supports the type filter.
  • Use sorting[] to control sort order. If you do not provide sorting, suppressions are ordered by created_at descending.
  • Use filters[] with id set to created_at and a value object containing start and/or end to apply a created-at date range filter.
  • Use per_page to control pagination size. The default is 10.
GET
/v1/workspaces/:workspace/suppressions

List suppressions for a workspace

Path parameters

workspacestring Required

ID of your workspace

Request body

searchstring

Query parameter used to search by suppression email

per_pagenumber

Query parameter for results per page. Defaults to `10`.

filters[]array

Query parameter containing JSON-encoded filter objects. Supported filter `id` values currently include `type` and `created_at`.

sorting[]array

Query parameter containing JSON-encoded sort descriptors

List Suppressions
curl "https://api.leadpush.io/v1/workspaces/:workspace/suppressions?per_page=10" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
Search and Filter Suppressions
curl "https://api.leadpush.io/v1/workspaces/:workspace/suppressions?search=blocked&filters[]=%7B%22id%22%3A%22type%22%2C%22value%22%3A%22manual%22%7D&sorting[]=%7B%22id%22%3A%22created_at%22%2C%22desc%22%3Atrue%7D" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
Response Example
{
"data": [
  {
    "_id": "<suppression_id>",
    "email": "blocked@example.test",
    "type": "manual",
    "created_at": "2021-01-01T00:00:00.000Z"
  }
],
"meta": {
  "current_page": 1,
  "per_page": 10
}
}