GET

List Number Pools

Returns every number pool in a sub-account with its members.

GEThttps://api.vantaxai.com/v1/number-pools

Each pool is returned with a `member_count` and the full `members` array so you can render counts and number chips without extra round-trips. Pools are ordered oldest-first.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Query Parameters

sub_account_idstringrequired
The sub-account to list number pools for.
example: sub_8a1f4c2e

Request

curl https://api.vantaxai.com/v1/number-pools?sub_account_id=sub_8a1f4c2e \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/number-pools?sub_account_id=sub_8a1f4c2e",
  { headers: { Authorization: "Bearer vx_live_3fa9c2..." } }
);
const { data: pools } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
const pools = await vantax.numberPools.list({ subAccountId: "sub_8a1f4c2e" });

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
pools = vantax.number_pools.list(sub_account_id="sub_8a1f4c2e")

Response

{
  "success": true,
  "data": [
    {
      "id": "pool_4c8e21",
      "name": "Outbound Sales Pool",
      "description": "Rotating numbers for the West Coast dialer",
      "sub_account_id": "sub_8a1f4c2e",
      "member_count": 2,
      "members": [
        {
          "id": "mem_91ad0c",
          "phone_number_id": "pn_55ad12",
          "number": "+14155550142",
          "source": "platform",
          "created_at": "2026-01-14T10:30:00Z"
        },
        {
          "id": "mem_7b22f4",
          "phone_number_id": "pn_77be34",
          "number": "+14155550199",
          "source": "twilio",
          "created_at": "2026-01-15T09:05:00Z"
        }
      ],
      "created_at": "2026-01-14T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "has_more": false
  }
}

{
  "success": false,
  "message": "Invalid or revoked API key"
}