Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve all IP pools



API Overview

api-overview page anchor

IP pools allow you to group your dedicated SendGrid IP addresses. For example, you could create separate one pool for your transactional email and another for your marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.

A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is determined by the aggregate performance of all email traffic sent from it.

IP pools can only be used with IP addresses for which you've set up a reverse DNS record.

If an IP pool is not specified for an email, it will use any IP available, including pooled addresses.

Each user can create up to 100 different IP pools.


GET/v3/ips/pools

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 get all of your IP pools.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
200
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
namestring

The name of the IP pool.

Retrieve all IP poolsLink to code sample: Retrieve all IP pools
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5
const request = {
6
url: `/v3/ips/pools`,
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
});