Suppressions - Suppressions
Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.
Retrieve all suppressions
GET /v3/asm/suppressions
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a list of all suppressions.
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Responses
array[object]
email
string
The email address that was suppressed.
group_id
integer
The id of the suppression group that this email address belongs to.
group_name
string
The name of the suppression group that this email address belongs to.
created_at
integer
A UNIX timestamp indicating when the suppression was created.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.