List all authenticated domains

An authenticated domain allows you to remove the "via" or "sent on behalf of" message that your recipients see when they read your emails. Authenticating a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will get 2 TXT records and 1 MX record.

Domain Authentication was formerly called "Domain Whitelabel".

For more information, please see How to set up domain authentication.

GET/v3/whitelabel/domains

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 domains you have authenticated.

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 authenticated domains 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

5
const request = {
6
  url: `/v3/whitelabel/domains`,
7
  method: 'GET',
8
  
9
}
10

11
client.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:

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

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

8
const request = {
9
  url: `/v3/whitelabel/domains`,
10
  method: 'GET',
11
  qs: queryParams
12
}
13

14
client.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:

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/whitelabel/domains`,
11
  method: 'GET',
12
  qs: queryParams
13
}
14

15
client.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
  });