List IP pools
List the IP pools visible to your account — your own plus the platform-shared ones.
A pool groups sending IPs that share a delivery backend and reputation. The API is account-scoped: you see the pools you created plus the platform-shared pools everyone sends through, but you can only create and modify your own. Platform pools stay staff-managed, so one tenant can never alter another tenant's sending infrastructure.
GET /v3/pools
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Page number, starting at 1. Default 1. |
per_page | integer | Optional | Pools per page, 1–100. Default 25. |
Responses
| Status | Description |
|---|---|
200 | OK. { items, pagination } where each pool carries id, account_id (null for platform-shared pools), name, provider, region, type, its ips array, a read-only reputation score and created_at, ordered oldest-first. |
401 | Missing or invalid API key. |
Pool types
| Parameter | Type | Required | Description |
|---|---|---|---|
dedicated | your traffic only | Optional | A fixed set of IPs reserved for your sending. |
shared | default | Optional | IPs whose reputation is shared across senders — the right choice until your volume justifies dedicated IPs. |
warming | ramping up | Optional | New IPs being warmed on a stepped volume curve before joining regular rotation. |
Code examples
cURL
curl https://api.wemail.io/v3/pools \
-H "Authorization: Bearer afn_live_…"Node.js
const res = await fetch("https://api.wemail.io/v3/pools", {
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/pools",
headers={"Authorization": f"Bearer {os.environ['WEMAIL_API_KEY']}"},
)
data = r.json()