availabilityRules

Fetches availability and unavailability rules for users and rooms.

When a clinician is deleted, their availability and unavailability rules are soft-deleted and are not returned, including when you query by userIds, roomIds, or locationIds. Existing bookings for a deleted clinician are unchanged.

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

availabilityRules(
  dateRange: DateRange
  userIds: [String]
  roomIds: [String]
  locationIds: [String]
  pagination: Pagination
): AvailabilityRulesData

Arguments

availabilityRules.dateRange ● DateRange input

If you specify a date range, availability rules are included when their stored startDate or endDate falls within the date range. Rules with no endDate are included when their startDate is on or before the end date.

availabilityRules.userIds ● [String] list scalar

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

availabilityRules.roomIds ● [String] list scalar

Room IDs — PracticeLocation.id.

Do not pass groupId here.

availabilityRules.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.

availabilityRules.pagination ● Pagination input

Pagination input for navigation through rule results.

Type

AvailabilityRulesData object

A collection of availability rules.