List what a calendar can book on

GET/assistants/{id}/calendars/{calendarId}/options

The calendars (Google) or event types (Calendly, Cal.com) of the account connected to the calendar, to pick the one it books on with PUT .../selection. Returns 400 when no account is connected.

Request

curl -X GET "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/calendars/b2d4f6a8-1c3e-4a5b-8d7f-9e0a1b2c3d4e/options" \
  -H "Authorization: Bearer $REVOX_API_KEY"

const res = await fetch("https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/calendars/b2d4f6a8-1c3e-4a5b-8d7f-9e0a1b2c3d4e/options", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.get(
    "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/calendars/b2d4f6a8-1c3e-4a5b-8d7f-9e0a1b2c3d4e/options",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{
  "options": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Appointment reminder",
      "detail": "30 min",
      "bookable": false
    }
  ],
  "selected_option_id": "9b8a7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
  "notice": "calendly_free_plan"
}

{
  "message": "Request validation failed",
  "bodyErrors": {
    "issues": [
      {
        "path": ["phone_number"],
        "message": "Invalid input: expected string, received undefined",
        "code": "invalid_type"
      }
    ]
  }
}

{ "error": "Not found" }

{ "error": "Server error" }

Path parameters

idstringrequired
ID of the assistant, as returned by GET /assistants.
calendarIdstringrequired
ID of the calendar, from the assistant's calendars list or GET /assistants/{id}/calendars.

Request body

No body: send the request without one.

Response

200

optionsarray of object
The calendars (Google) or event types (Calendly, Cal.com) of the connected account.
selected_option_idstringnullable
The option the calendar books on now. Null until one is picked.
notice"calendly_free_plan" | "calendly_trial"nullable
Something about the account that will stop bookings. Null when there is nothing to report.
"calendly_free_plan"
The Calendly account is on the free plan: Calendly only books through its API on a paid plan (Standard or above), so the agent will see the slots but cannot book them.
"calendly_trial"
The Calendly account is on a trial: Calendly only books through its API on a paid plan (Standard or above). Without one, the agent will see the slots but cannot book them.

Errors

400Invalid request: a field or parameter failed validation{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
404Not found in your organization{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
500Server error{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.