List IPs

Inventory the sending IPs visible to your account, flattened across pools.

Flattens the pools visible to your account — the ones you created plus the platform-shared pools everyone sends through — into one IP inventory. Each item is { ip, pool_id, pool_name, provider, region }.

GET /v3/ips

Query parameters

ParameterTypeRequiredDescription
pageintegerOptionalPage number over the flattened IP list, starting at 1. Default 1.
per_pageintegerOptionalIPs per page, 1–100. Default 25.
pool_iduuidOptionalRestrict the inventory to the IPs of a single pool.

Responses

StatusDescription
200OK. { items: [{ ip, pool_id, pool_name, provider, region }], pagination: { page, per_page, total_count, total_pages } }.
401Missing or invalid API key.

Code examples

cURL
curl https://api.wemail.io/v3/ips \
  -H "Authorization: Bearer afn_live_…"
Node.js
const res = await fetch("https://api.wemail.io/v3/ips", {
  headers: {
    Authorization: `Bearer ${process.env.WEMAIL_API_KEY}`,
  },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.wemail.io/v3/ips",
    headers={"Authorization": f"Bearer {os.environ['WEMAIL_API_KEY']}"},
)
data = r.json()