Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve all suppressions for a suppression group



API Overview

api-overview page anchor

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.


GET/v3/asm/groups/{group_id}/suppressions

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Property nameTypeRequiredDescription
group_idstringrequired

The id of the unsubscribe group that you are adding suppressions to.

200
SchemaExample
array[string<email>]

The list of email addresses belonging to the given suppression group.

Retrieve all suppressions for a suppression groupLink to code sample: Retrieve all suppressions for a suppression group
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const group_id = "ZGkrHSypTsudrGkmdpJJ";
5
6
const request = {
7
url: `/v3/asm/groups/${group_id}/suppressions`,
8
method: 'GET',
9
10
}
11
12
client.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch(error => {
18
console.error(error);
19
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.