Availabilities
Read your inspectors' open time slots over a date range and a set of services, to pick a time before creating an inspection. Working hours, time off, blocked time and existing bookings are applied; service limitations and service areas are not, so every inspector is listed.
List availabilities
Returns your inspectors' open start times, per inspector and per day, for the requested services over a date range of at most 1 month. Every visible inspector is listed; one with nothing open has days with empty slots. Applied: working hours, time off and blocked time, existing inspections, events and placeholders. Not applied: your service limitations and service areas, so an inspector who can't perform the service or doesn't cover the property is still listed; your scheduler's minimum lead time, so a slot can start soon after now; and duration modifiers such as square footage or age. The slot length is the duration you send, else the sum of the requested services' and add-ons' base durations, else your company's default (meta.duration). Times are in your company's time zone (meta.time_zone).
query Parameters
start_dateFirst day of the range (YYYY-MM-DD)
end_dateLast day of the range (YYYY-MM-DD), at most 1 month after start_date
service_ids[]IDs of the services to book: service_ids[]=12&service_ids[]=34. Each must be one of your company's services; hidden services are accepted. Send them to get slots the length of that booking — with none, the slot length falls back to your company's default.
service_add_on_ids[]IDs of add-ons to include in the slot length. Each must belong to one of your company's services.
durationSlot length in hours, overriding the one derived from the services. Send it only when you know the booking will not match its services' base durations, or the slots you pick may not fit what you create.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List availabilities › Responses
Availabilities retrieved successfully

