Skip to main content

GET /email_delivery/suppressions

GET 
email_delivery/suppressions

Retrieve all email suppression records for the current user

Query Parameters​

type string
Filter by suppression type. Supports multiple types. Can be passed as comma-separated string (e.g., "unsubscribe,bounce") or JSON array (e.g., ["unsubscribe","bounce"]).

recipient string
Filter by recipient email address (case-insensitive partial match)

offset integer

limit integer

sort string
example -created_at (desc) or created_at (asc)

Returns

  • dataarray
    • idstring
      Suppression record ID
    • domainstring
      Domain name
    • recipientstring
      Recipient email address
    • recipient_domainstring
      Recipient domain
    • unsubscribeboolean
      Whether this is an unsubscribe suppression
    • unsubscribed_atstring
      Timestamp when unsubscribed
    • unsubscribe_reasonstring
      Reason for unsubscribing (max 1024 characters)
    • hard_bounceboolean
      Whether this is a hard bounce suppression
    • hard_bounced_atstring
      Timestamp when hard bounced
    • feedback_reportboolean
      Whether feedback was reported
    • feedback_reported_atstring
      Timestamp when feedback was reported
    • bounce_responseobject
      Bounce response details
    • manualboolean
      Whether this suppression was added manually by the user
    • manual_reasonstring
      Reason for manual suppression (max 1024 characters)
    • created_atstring
      Creation timestamp
    • updated_atstring
      Last update timestamp
  • metaobject
    Pagination metadata for list responses
    • countinteger
      Total number of items available
    • offsetinteger
      Number of items skipped
    • limitinteger
      Maximum number of items returned per request
Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error