GET

List Subaccount Numbers

Returns the phone numbers owned by a sub-account.

GEThttps://api.vantaxai.com/v1/phone-numbers

Lists every number provisioned through the platform or imported into the given sub-account, including its current Agent assignment and messaging capabilities. Results are returned newest-first.

Headers

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

Query Parameters

sub_account_idstringrequired
The sub-account whose numbers you want to list.
example: sub_8a1f4c2e
sourcestringoptional
Filter by how the number was acquired.
platformimported
limitintegeroptional
Number of records to return (1–100). Defaults to 20.
example: 20
starting_afterstringoptional
Cursor for pagination — a phone number id to start after.
example: pn_55ad12

Request

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

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

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
const numbers = await vantax.phoneNumbers.list({ subAccountId: "sub_8a1f4c2e", limit: 20 });

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
numbers = vantax.phone_numbers.list(sub_account_id="sub_8a1f4c2e", limit=20)

Response

{
  "success": true,
  "data": [
    {
      "id": "pn_55ad12",
      "number": "+14155550142",
      "country": "US",
      "source": "platform",
      "agent_id": "agt_3d9b21",
      "sub_account_id": "sub_8a1f4c2e",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "created_at": "2026-01-14T10:30:00Z"
    },
    {
      "id": "pn_91be77",
      "number": "+14155550199",
      "country": "US",
      "source": "imported",
      "agent_id": null,
      "sub_account_id": "sub_8a1f4c2e",
      "capabilities": {
        "voice": true,
        "sms": false
      },
      "created_at": "2026-01-20T16:05:00Z"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 20,
    "has_more": false
  }
}

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