GET

Get Number Pool

Retrieves a single number pool and its members.

GEThttps://api.vantaxai.com/v1/number-pools/{pool_id}

Headers

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

Path Parameters

pool_idstringrequired
The pool's unique identifier.
example: pool_4c8e21

Request

curl -X GET https://api.vantaxai.com/v1/number-pools/pool_4c8e21 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

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

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// GET /v1/number-pools/{pool_id}
const result = await vantax.request("GET", "/v1/number-pools/{pool_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# GET /v1/number-pools/{pool_id}
result = vantax.request("GET", "/v1/number-pools/{pool_id}")

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

{ "success": false, "message": "Pool not found" }