On this page

Get a List of Subusers Assigned to an IP

API Overview

The IP Address Management API combines functionality that was previously split between the Twilio SendGrid IP Address API and IP Pools API. This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks. More details about each operation can be found in the descriptions and schemas for each endpoint.

(information)

Info

Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More

(warning)

Warning

The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice.

Operation overview

GET/v3/send_ips/ips/{ip}/subusers

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

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

This operation returns a list of Subuser IDs that have been assigned the specified IP address. To retrieve more information about the returned Subusers, use the Subusers API.

You can use the after_key and limit query parameters to iterate through paginated results. The maximum limit is 100, meaning you may retrieve up to 100 Subusers per request. If the after_key in the API response is not null, there are more Subusers assigned to the IP address than those returned in the request. You can repeat the request with the non-null after_key value and the same limit to retrieve the next group of Subusers.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

ipstringrequired

The ip path parameter specifies an IP address to make the request against.

Query string

Property nameTypeRequiredDescription

after_keyintegerOptional

Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.

limitintegerOptional

Specifies the number of results to be returned by the API. This parameter can be used in combination with the after_key parameters to iterate through paginated results. The maximum limit is 100.

Maximum: 100

Responses

200400401500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultarray[string]

An array of Subuser IDs that have been assigned the specified IP address.

_metadataobject

Show child properties for _metadata

Bad Request

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Unauthorized

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Internal Server Error

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Get a List of Subusers Assigned to an IP

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