availabilitySlots

Fetches bookable availability slots for users and rooms within a date range, after subtracting overlapping bookings and unavailabilities.

Important: This query is only available for practices using the New Semble Appointment System. Learn more

availabilitySlots(
  dateRange: AvailabilitySlotsDateRange!
  userIds: [String]
  roomIds: [String]
  locationIds: [String]
  excludeBookingIds: [ID]
  pagination: Pagination
): AvailabilitySlotData

Arguments

availabilitySlots.dateRange ● AvailabilitySlotsDateRange! non-null input

The range to search for availability slots. start is inclusive and end is exclusive. To search one full day, use the next day as end.

availabilitySlots.userIds ● [String] list scalar

List of user IDs to fetch availability for. At least one user, room, or location must be provided.

availabilitySlots.roomIds ● [String] list scalar

Room IDs — PracticeLocation.id.

Do not pass groupId here.

availabilitySlots.locationIds ● [String] list scalar

Location IDs — PracticeLocation.groupId

Do not pass room IDs (PracticeLocation.id) here. A room ID in locationIds matches no locations, and returns no rules rather than an error.

availabilitySlots.excludeBookingIds ● [ID] list scalar

Bookings to omit from conflict subtraction (e.g. when rescheduling). Up to 5 IDs

availabilitySlots.pagination ● Pagination input

Pagination input for navigation through slot results.

Type

AvailabilitySlotData object

A collection of consolidated availability slots.