Retrieve all bounces

API Overview

An email is considered bounced when the message is undeliverable and then returned to the server that sent it. Bounced emails can be either permanent or temporary failures to deliver the message.

For more information, see our Bounces documentation.

You can also manage bounced emails from the Suppression settings menu in the Twilio SendGrid App.

Operation overview

GET/v3/suppression/bounces

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 your bounces.

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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Acceptstring

required

Default: application/json

on-behalf-ofstring

Optional

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.

Query string

Property nameTypeRequiredDescription

start_timeinteger

Optional

Refers start of the time range in unix timestamp when a bounce was created (inclusive).

end_timeinteger

Optional

Refers end of the time range in unix timestamp when a bounce was created (inclusive).

limitinteger

Optional

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

Optional

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.

Default: 0Minimum: 0

emailstring

Optional

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, e.g., the @ symbol should be encoded as %40.

Responses

200401

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

creatednumber

Optional

The unix timestamp for when the bounce record was created at SendGrid.

emailstring<email>

Optional

The email address that was added to the bounce list.

reasonstring

Optional

The reason for the bounce. This typically will be a bounce code, an enhanced code, and a description.

statusstring

Optional

Enhanced SMTP bounce response

Retrieving paginated results

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

Retrieve first page from list of all bounces

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const headers = { Accept: "application/json" };
5
6const request = {
7  url: `/v3/suppression/bounces`,
8  method: "GET",
9  headers: headers,
10};
11
12client
13  .request(request)
14  .then(([response, body]) => {
15    console.log(response.statusCode);
16    console.log(response.body);
17  })
18  .catch((error) => {
19    console.error(error);
20  });

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 bounces with a specified page size

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const headers = { Accept: "application/json" };
5const queryParams = { limit: 5 };
6
7const request = {
8  url: `/v3/suppression/bounces`,
9  method: "GET",
10  headers: headers,
11  qs: queryParams,
12};
13
14client
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:

Retrieve a specific page from the list of all bounces

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const headers = { Accept: "application/json" };
5const queryParams = {
6  limit: 5,
7  offset: 15,
8};
9
10const request = {
11  url: `/v3/suppression/bounces`,
12  method: "GET",
13  headers: headers,
14  qs: queryParams,
15};
16
17client
18  .request(request)
19  .then(([response, body]) => {
20    console.log(response.statusCode);
21    console.log(response.body);
22  })
23  .catch((error) => {
24    console.error(error);
25  });

Use the `email` query parameter to filter results

The code samples below show how to use the email query parameter to filter the Bounce records returned by the GET request. A Bounce record is included in the results if the Bounce'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.

Filter results without wildcard

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

Filter results without wildcard

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const headers = { Accept: "application/json" };
5const queryParams = { email: "sales" };
6
7const request = {
8  url: `/v3/suppression/bounces`,
9  method: "GET",
10  headers: headers,
11  qs: queryParams,
12};
13
14client
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 Bounces with email addresses that start with "sales", such as salesteam@example.com or sales@example.com.

Filter results with wildcard

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

Filter results with a wildcard

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const headers = { Accept: "application/json" };
5const queryParams = { email: "%25sales" };
6
7const request = {
8  url: `/v3/suppression/bounces`,
9  method: "GET",
10  headers: headers,
11  qs: queryParams,
12};
13
14client
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 Bounces with email addresses that contain "sales" anywhere in the email address, such as george@sales.example.com or sales@example.com.

Retrieve all bounces

API Overview

Operation overview

GET/v3/suppression/bounces

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

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

Operation details

Authentication

Headers

Query string

Responses

Retrieving paginated results

Use the email query parameter to filter results

Filter results without wildcard

Filter results with wildcard

Use the `email` query parameter to filter results