API referenceSuppressions
List suppressions
Addresses marketing is never sent to, the latest first; search by address.
GET
Addresses marketing is never sent to, the latest first; search by address.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200reason?stringComma-separated, any of: hard_bounce, spam_complaint, soft_bounces, invalid, manual
sort?stringOne of createdAt, address; prefix with - for descending
Default
"-createdAt"Value in
"createdAt""-createdAt""address""-address"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/suppressions'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "address": "string", "reason": "hard_bounce", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "detail": "string", "addedBy": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}