Skip to content Skip to navigation Skip to topbar

Retrieve all suppressions

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/suppressions

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

This endpoint allows you to retrieve a list of all suppressions.

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.

Responses

200

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

emailstring

The email address that was suppressed.

group_idinteger

The id of the suppression group that this email address belongs to.

group_namestring

The name of the suppression group that this email address belongs to.

created_atinteger

A UNIX timestamp indicating when the suppression was created.

Retrieve all suppressions

Node.js

Python

Java

PHP

Ruby

curl


_18const client = require('@sendgrid/client');
_18client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18const request = {
_18  url: `/v3/asm/suppressions`,
_18  method: 'GET',
_18  
_18}
_18
_18client.request(request)
_18  .then(([response, body]) => {
_18    console.log(response.statusCode);
_18    console.log(response.body);
_18  })
_18  .catch(error => {
_18    console.error(error);
_18  });