GET

List Contacts

Returns a paginated list of contacts in your sub-account.

GEThttps://api.vantaxai.com/v1/contacts

Contacts are returned newest-first. Use the `limit` and `starting_after` cursor parameters to page through large collections, and `search` to match against name, email, or phone.

Headers

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

Query Parameters

sub_account_idstringrequired
The sub-account to list contacts for.
example: sub_8a1f4c2e
limitintegeroptional
Number of records to return (1–100). Defaults to 20.
example: 20
starting_afterstringoptional
Cursor for pagination — a contact id to start after.
example: ct_9b21d3
searchstringoptional
Filter by a substring of the contact's name, email, or phone.
example: jordan
statusstringoptional
Filter by contact status.
activedeactivated
example: active

Request

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

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

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

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

from vantax import Vantax

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

Response

{
  "success": true,
  "data": [
    {
      "id": "ct_9b21d3",
      "first_name": "Jordan",
      "last_name": "Avery",
      "email": "jordan.avery@example.com",
      "phone": "+14155550142",
      "status": "active",
      "address": "200 Market St, San Francisco, CA",
      "lead_source": "website",
      "tags": ["vip", "newsletter"],
      "created_at": "2026-01-14T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "has_more": false
  }
}

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