GET/v1/suppressions

List suppression entries

Cursor paged (API-005); search matches name, address line, postal code and city.

Scope items.read

Query parameters

limitintegermin 1max 200default 50

cursorstring

Opaque cursor from nextCursor of the previous page (same sort and filters).

sortstring

Comma separated, prefix - for descending; fields: createdAt, postalCode, name. Default -createdAt.

includeenum

include=total adds totalCount.

total

filter[reason]string

filter[source]enum

manualcsvapi

filter[source][in]string

Comma separated values

filter[country]string

filter[createdAt][gte]date-time

filter[createdAt][gt]date-time

filter[createdAt][lte]date-time

filter[createdAt][lt]date-time

filter[search][contains]string

Returns

4 fields of the 200 answer

dataarray of objectsrequired

12 fields

idstringrequired

namestringrequired

addressLine1stringrequired

addressLine2string or nullrequired

postalCodestringrequired

citystringrequired

countrystringrequired

reasonstringrequired

categoriesarray of stringrequired

sourceenumrequired

manualcsvapi

notestring or nullrequired

createdAtdate-timerequired

nextCursorstring or nullrequired

hasMorebooleanrequired

totalCountinteger

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.suppressions.list({ query: { limit: 20, }, });

{ "data": [ { "id": "sup_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "addressLine1": "Oudegracht 112", "addressLine2": "2nd floor", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", "reason": "Example", "categories": [ "Example" ], "source": "manual", "note": "Example", "createdAt": "2026-10-16T09:14:02.000Z" } ], "nextCursor": "Example", "hasMore": false, "totalCount": 3 }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }