Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve all Global Suppressions



API Overview

api-overview page anchor

Global suppressions are the email addresses of recipients who have indicated that they would like unsubscribe from all the email you send by clicking on the Unsubscribe From All Emails link within your emails. Once a recipient's address is on the global suppressions list, they will not receive any emails from you.


GET/v3/suppression/unsubscribes

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

This endpoint allows you to retrieve a paginated list of all email address that are globally suppressed.

You can use the limit query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the offset query parameter to control the position in the list from which to start retrieving additional items.


Authentication

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

on-behalf-ofstring

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.

start_timeinteger

Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).


end_timeinteger

Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).


limitinteger

limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page.

Minimum: 1Maximum: 500

offsetinteger

The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list.

Minimum: 0Default: 0

emailstring

Specifies which records to return based on the records' associated email addresses. For example, sales returns records with email addresses that start with 'sales', such as salesdepartment@example.com or sales@example.com. You can also use %25 as a wildcard. For example, %25market returns records containing email addresses with the string 'market' anywhere in the email address, and %25market%25tree returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be percent-encoded(link takes you to an external page), e.g., the @ symbol should be encoded as %40.

200
SchemaExample

Array of:

createdinteger

A Unix timestamp indicating when the recipient was added to the global suppression list.


emailstring<email>

The email address of the recipient who is globally suppressed.


Retrieving paginated results

retrieving-paginated-results page anchor

To perform a request for the first page of the paginated list of all global suppressions using the default page size, you can omit the limit and offset query parameters:

Retrieve first page from list of all global suppressions

retrieve-first-page-from-list-of-all-global-suppressions page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/suppression/unsubscribes`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.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
});

If you want to specify a page size of your choice, you can use the limit query parameter. Assume you want a page size of no more than 5 items per request, to retrieve the first page you can use the limit parameter without specifying an offset:

Retrieve first page from list of all global suppressions with a specified page size

retrieve-first-page-from-list-of-all-global-suppressions-with-a-specified-page-size page anchor

Setting page size to 5 using the limit query parameter

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"limit": 10
_21
};
_21
_21
const request = {
_21
url: `/v3/suppression/unsubscribes`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});

If you want to retrieve items beyond the first page, you can use the offset parameter as follows. Assume you are still working with a page size of 5 as determined by your limit query parameter and you have more than 15 items. To request the fourth page of items, you can use the offset parameter to skip over the first 15 items, i.e. you start retrieving items starting after the first three pages of 5 items each:

Retrieve a specific page from the list of all global suppressions

retrieve-a-specific-page-from-the-list-of-all-global-suppressions page anchor

Using the offset query parameter in combination with the limit query parameter

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const queryParams = {
_22
"limit": 5,
_22
"offset": 15
_22
};
_22
_22
const request = {
_22
url: `/v3/suppression/unsubscribes`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Use the email query parameter to filter results

use-the-email-query-parameter-to-filter-results page anchor

The code samples below show how to use the email query parameter to filter the Global Suppression records returned by the GET request. A Global Suppression record is included in the results if the Global Suppression's email property starts with the the value of the email query parameter. One or more %25 wildcards can be used in the email query parameter.

Any reserved characters should be percent-encoded(link takes you to an external page) to avoid any unintended encoding/decoding of characters.

Filter results without wildcard

filter-results-without-wildcard page anchor

The code sample below shows examples of how to GET all Global Suppression records with email properties that begin with the string "sales".

Filter results without wildcard

filter-results-without-wildcard-1 page anchor

GET all Global Suppression records with email properties that start with 'sales'

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"email": "sales"
_21
};
_21
_21
const request = {
_21
url: `/v3/suppression/unsubscribes`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});

This request would return Global Suppressions with email addresses that start with "sales", such as salesteam@example.com or sales@example.com.

Filter results with wildcard

filter-results-with-wildcard page anchor

The code sample below shows examples of how to GET all Global Suppression records with email properties that contain the string "sales" anywhere in the email address.

Filter results with a wildcard

filter-results-with-a-wildcard page anchor

GET all Global Suppression records with email properties that contain the string 'sales' anywhere in the email address

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"email": "%25sales"
_21
};
_21
_21
const request = {
_21
url: `/v3/suppression/unsubscribes`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});

This request would return Global Suppressions with email addresses that contain "sales" anywhere in the email address, such as george@sales.example.com or sales@example.com.


Rate this page: