On this page

Retrieve all mail settings

API Overview

Mail Settings instruct SendGrid to apply specific settings to every email that you send over SendGrid's v3 API or SMTP Relay. These settings include how to embed a custom footer, how to manage blocks, spam, and bounces, and more.

For a full list of Twilio SendGrid's Mail Settings, and what each one does, see our Mail Settings documentation.

You can also manage your Mail Settings in the Twilio SendGrid App

Operation overview

GET/v3/mail_settings

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 mail settings.

Each setting will be returned with an enabled status set to true or false and a short description that explains what the setting does.

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

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.

Query string

Property nameTypeRequiredDescription

limitintegerOptional

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.

offsetintegerOptional

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

Responses

200400401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultarray[object]

The list of all mail settings.

Show child properties for result

Retrieving paginated results

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

Retrieve first page from list of all mail settings

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5const request = {
6  url: `/v3/mail_settings`,
7  method: 'GET',
8  
9}
10
11client.request(request)
12  .then(([response, body]) => {
13    console.log(response.statusCode);
14    console.log(response.body);
15  })
16  .catch(error => {
17    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 mail settings with a specified page size

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  "limit": 5
6};
7
8const request = {
9  url: `/v3/mail_settings`,
10  method: 'GET',
11  qs: queryParams
12}
13
14client.request(request)
15  .then(([response, body]) => {
16    console.log(response.statusCode);
17    console.log(response.body);
18  })
19  .catch(error => {
20    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 mail settings

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