Get all AvailabilitySlots

get

https://api.vcita.biz/v3/scheduling/availability_slots

Overview

This endpoint returns available time slots for booking appointments. It considers staff schedules, resource availability, existing bookings, and business hours to compute open slots.

Available for Staff, Directory, and Client tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start_time

date-time

required

Start time for availability search in ISO 8601 format (UTC). Must be a valid date-time string.

end_time

date-time

required

End time for availability search in ISO 8601 format (UTC). Must be after start_time. Recommended range is up to 31 days.

service_uid

string

Unique identifier of the service

resource_type_uids

string

Comma-separated list of resource type UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.

resource_uids

string

Comma-separated list of resource UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.

staff_uids

string

Comma-separated list of staff UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.

slot_duration

integer

≥ 1

Duration of each slot in minutes

slot_interval

integer

≥ 1

Interval between slots in minutes (if relevant)

padding_before

integer

≥ 0

Padding time before each slot in minutes (if relevant)

padding_after

integer

≥ 0

Padding time after each slot in minutes (if relevant)

exclude_booking_uid

string

Unique identifier of a booking to exclude from busy slots calculation when determining availability. When provided, the specified booking is temporarily removed from the busy slots list before calculating available time slots. This is essential for rescheduling scenarios where you need to check if the original time slot would be available without the current booking, or for conflict detection when validating potential overlaps. Example: If booking 'abc123' is scheduled from 2:00-3:00 PM and you want to reschedule it, passing exclude_booking_uid=abc123 will show 2:00-3:00 PM as available (assuming no other bookings conflict). If other bookings exist during that time, the slot remains busy.

Responses

400

Invalid request parameters - missing required parameters or invalid values

401

Unauthorized

404

Service or specified resources not found

500

Internal server error

200Availability slots retrieved successfully