Skip to content Skip to navigation Skip to topbar

Retrieve all suppressions for a suppression group

API Overview

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.

Operation overview

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

Base url: https://api.sendgrid.com

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

Operation details

Authentication

API Key

Headers

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.

Path parameters

Property nameTypeRequiredDescription

group_idstringrequired

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

Responses

200

SchemaExample

array[string<email>]

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

Retrieve all suppressions for a suppression group

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const group_id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19const request = {
_19  url: `/v3/asm/groups/${group_id}/suppressions`,
_19  method: 'GET',
_19  
_19}
_19
_19client.request(request)
_19  .then(([response, body]) => {
_19    console.log(response.statusCode);
_19    console.log(response.body);
_19  })
_19  .catch(error => {
_19    console.error(error);
_19  });