GET

List Calendars

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

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

Calendars are returned alphabetically by name. Use the `limit` and `starting_after` cursor parameters to page through large collections.

Headers

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

Query Parameters

sub_account_idstringrequired
The sub-account to list calendars for.
example: sub_8a1f4c2e
limitintegeroptional
Number of records to return (1–100). Defaults to 20.
example: 20
starting_afterstringoptional
Cursor for pagination — a calendar id to start after.
example: cal_22f9
is_activebooleanoptional
Filter by active state.
example: true

Request

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

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

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

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

from vantax import Vantax

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

Response

{
  "success": true,
  "data": [
    {
      "id": "cal_22f9",
      "name": "Front Desk Bookings",
      "description": "Default calendar for inbound scheduling calls",
      "color": "#2563eb",
      "is_active": true,
      "slot_duration_minutes": 30,
      "sub_account_id": "sub_8a1f4c2e",
      "created_at": "2026-01-14T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 3,
    "limit": 20,
    "has_more": false
  }
}

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