Skip to main content
GET
/
v4
/
booking-availability
Get booking availability for a meeting type
curl --request GET \
  --url https://api.example.com/v4/booking-availability
{
  "timezone": "<string>",
  "timeframes": [
    {
      "start": "<string>",
      "end": "<string>",
      "unavailabilityEvent": {
        "hostId": "<string>",
        "hostName": "<string>",
        "type": "event",
        "picture": "<string>"
      }
    }
  ],
  "dates": [
    {
      "date": "<string>",
      "spots": [
        {
          "startTime": "<string>",
          "unavailabilityEvents": [],
          "appointment": {
            "id": "<string>",
            "totalSpots": 123,
            "takenSpots": 123
          }
        }
      ]
    }
  ],
  "earliestAvailableDate": "<string>"
}

Query Parameters

​
meetingTypeId
string
required
​
meetingDuration
number
​
start
string
required
​
end
string
required
​
hostIds
string[]
​
queueId
string

Queue ID of meeting type for hosts in round robin

​
existingAppointmentId
string

Appointment ID of previous booking for rescheduling

​
calculationMethod
enum<string>
Available options:
everyone,
anyone
​
timezone
string
​
hideGroupAppointments
boolean
​
skipEarliestBookingCalculation
boolean
​
troubleshoot
boolean
default:false

Get blocked timeslots with available slots for diagnostics

​
refreshCache
boolean

Force cache refresh (skip read, write result). Used after slot-occupied error to fetch fresh availability.

​
resourceChannelIds
string[]

Ids of the resource channel entity

​
channel
enum<string>

Selected channel for per-channel availability lookup Meeting channel/location type

Available options:
local,
local-attendee,
google,
zoom,
phone,
phone-incoming,
whatsapp,
connect,
webex,
whereby,
kmeet,
jitsi,
zava,
teamsForBusiness2,
custom,
resource

Response

​
timezone
string
required
​
timeframes
object[]
required
​
dates
object[]
required
​
earliestAvailableDate
string