Elements that can be shared among more than one endpoint definition.
This endpoint allows you to retrieve a paginated list of all assigned and unassigned IPs.
Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP.
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.
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.
Bearer <<YOUR_API_KEY_HERE>>The IP address to get
Should we exclude reverse DNS records (whitelabels)?
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.
1Default: 10The 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.
0Default: 0The subuser you are requesting for.
The direction to sort the results.
descascArray of:
An IP address.
The subusers that are able to send email from this IP.
The reverse DNS record for this IP address.
The IP pools that this IP has been added to.
Indicates if this IP address is currently warming up.
The date that the IP address was entered into warmup.
Indicates if this IP address is associated with a reverse DNS record.
The date that the IP address was assigned to the user.
To perform a request for the first page of the paginated list of all IP addresses using the default page size, you can omit the limit and offset query parameters:
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:
Setting page size to 5 using the limit query parameter
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:
Using the offset query parameter in combination with the limit query parameter