Get a suppression entry

Scope items.read

Path parameters

idstringrequired

Returns

12 fields of the 200 answer

idstringrequired

namestringrequired

addressLine1stringrequired

addressLine2string or nullrequired

postalCodestringrequired

citystringrequired

countrystringrequired

reasonstringrequired

categoriesarray of stringrequired

sourceenumrequired

manualcsvapi

notestring or nullrequired

createdAtdate-timerequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

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

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/suppressions/sup_01J9Y2K8QF4T6W8Z0B2D4F6H8K \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.suppressions.get('sup_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.suppressions.get("sup_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "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"
}

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}