Retrieve all Global Suppressions

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 (for global users and subusers)

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

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.

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:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const request = {
5
  url: `/v3/suppression/unsubscribes`,
6
  method: "GET",
7
};
8

9
client
10
  .request(request)
11
  .then(([response, body]) => {
12
    console.log(response.statusCode);
13
    console.log(response.body);
14
  })
15
  .catch((error) => {
16
    console.error(error);
17
  });

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:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  limit: 10,
6
};
7

8
const request = {
9
  url: `/v3/suppression/unsubscribes`,
10
  method: "GET",
11
  qs: queryParams,
12
};
13

14
client
15
  .request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch((error) => {
21
    console.error(error);
22
  });

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:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  limit: 5,
6
  offset: 15,
7
};
8

9
const request = {
10
  url: `/v3/suppression/unsubscribes`,
11
  method: "GET",
12
  qs: queryParams,
13
};
14

15
client
16
  .request(request)
17
  .then(([response, body]) => {
18
    console.log(response.statusCode);
19
    console.log(response.body);
20
  })
21
  .catch((error) => {
22
    console.error(error);
23
  });

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 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 to avoid any unintended encoding/decoding of characters.

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

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  email: "sales",
6
};
7

8
const request = {
9
  url: `/v3/suppression/unsubscribes`,
10
  method: "GET",
11
  qs: queryParams,
12
};
13

14
client
15
  .request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch((error) => {
21
    console.error(error);
22
  });

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

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.

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  email: "%25sales",
6
};
7

8
const request = {
9
  url: `/v3/suppression/unsubscribes`,
10
  method: "GET",
11
  qs: queryParams,
12
};
13

14
client
15
  .request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch((error) => {
21
    console.error(error);
22
  });

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.