14666f4db0f8
Retrieve booking availability
Beta: This endpoint is subject to change and may contain bugs. Breaking changes may occur without notice.
Returns the list of available booking slots for the account within the requested date range.
Only slots that still have open capacity are returned, so a day with no returned slots is fully booked or unavailable.
Each slot includes a userIds array containing the IDs of users who are already occupying capacity in that slot.
Use jobTypes to restrict availability to the technicians who can perform those job types, and availableBased/totalSpots/scheduleOffset/showHolidays to override account booking settings for the request without changing them.
The range cannot exceed 60 days.
Query parameters
The first date of the range to return availability for, in YYYY-MM-DD format. Defaults to today when omitted.
The last date of the range to return availability for, in YYYY-MM-DD format. Must be on or after the start date, and the range cannot exceed 60 days. Defaults to 31 days after the start date when omitted.
The slot length in minutes. Must be between 30 and 480 (8 hours) in steps of 30. Defaults to the account configured slot length when omitted.
Comma-separated list of job type IDs (prefix JT-). When provided, availability is restricted to the technicians who can perform any of those job types.
Overrides the account capacity mode for this request only: 0 = no capacity limit, 1 = based on available technicians, 2 = maximum jobs per slot. Defaults to the account configured mode when omitted.
Overrides the total capacity per slot for this request only. Mainly useful together with availableBased=2 to set the maximum jobs per slot without changing the account settings.
Overrides the minimum notice window in hours for this request only. Allowed values: 0 (none), 1–10 (hours), or 24/48/72/96/120/144/168 (1–7 days). Slots earlier than now plus this offset are excluded. Defaults to the account configured schedule offset when omitted.
Overrides whether public holidays block slots for this request only: 0 = ignore holidays, 1 = apply the holiday calendar. Defaults to the account configured setting when omitted.
Headers
Bearer Token
Response
A list of available booking slots.
Example response
{
"totalResults": 100,
"data": [
{
"startTime": "2026-01-15 09:00",
"startTimestamp": 1768460400,
"slotLength": 60,
"totalSpots": 3,
"openSpots": 2,
"userIds": [
"USR-83510a9930f203f4",
"USR-a4f86bf1deefec12",
"USR-d59dbcd34aa19dce"
]
}
]
}