List calendars

GET
/v1/calendar/calendars

Lists the calendars on the connected account: the person's main one, any made for an agent, and which of them count when checking whether the person is free. With several accounts connected and none named, every working account is listed.

Requires an API key with the calendar:use scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Query Parameters

connectionId?string

Only needed when more than one calendar account is connected: the id of the account to use, from GET /v1/calendar/status.

Length1 <= length <= 64

Response Body

The calendars and which count as busy

application/json
  1. response
calendars*array<>
summary*string
Example Request
curl https://api.vlayers.ai/v1/calendar/calendars \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "calendars": [    {      "connectionId": "0192f5c0-1a2b-7c3d-8e4f-5a6b7c8d9e01",      "account": "[email protected]",      "app": "Google Calendar",      "id": "[email protected]",      "name": "Sales agent",      "main": false,      "agentCalendar": true,      "mailbox": "[email protected]",      "countsForAvailability": true    }  ],  "summary": "1 calendar. When checking if you're free I look at: Sales agent."}