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 }.

How IPs and pools work

By default every account sends through wemail's shared pools, whose reputation is managed for everyone. Accounts with steady volume can request dedicated IPs; these are grouped into pools you own, warmed up automatically over the first weeks, and used for the traffic you route to them. An IP belongs to exactly one pool, and a pool belongs either to the platform (shared) or to your account (dedicated). The inventory below is read-only — IPs are assigned by wemail — while pools are yours to create and rename.

Endpoints in this section

GET /v3/ips flattens every visible pool into one IP list (this page). GET /v3/pools lists the pools themselves with their IP counts. POST /v3/pools creates a pool owned by your account and PATCH /v3/pools/{id} renames it or changes its settings. Dedicated IPs are provisioned from the Console; there is no self-service purchase endpoint.

GET /v3/ips

Query parameters

Parameter	Type	Required	Description
`page`	integer	Optional	Page number over the flattened IP list, starting at 1. Default 1.
`per_page`	integer	Optional	IPs per page, 1–100. Default 25.
`pool_id`	uuid	Optional	Restrict the inventory to the IPs of a single pool.

Responses

Status	Description
`200`	OK. `{ items: [{ ip, pool_id, pool_name, provider, region }], pagination: { page, per_page, total_count, total_pages } }`.
`401`	Missing 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()