INPUT_OBJECT

AppointmentScheduleFilterInput

Filter conditions for AppointmentSchedule records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input AppointmentScheduleFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [AppointmentScheduleFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [AppointmentScheduleFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: AppointmentScheduleFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Description applied to appointments booked through this schedule.
  • appointmentDescription: EntityFilterStringField
  • # Duration of each booked appointment.
  • appointmentDuration: EntityFilterNumberField
  • # Location applied to appointments booked through this schedule.
  • appointmentLocation: EntityFilterStringField
  • # Where booked appointments take place: the location given in appointmentLocation
  • # (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
  • appointmentLocationType: AppointmentScheduleLocationTypeEnumFilterInput
  • # Id of the user receiving the booking.
  • appointmentOwnerId: EntityFilterStringField
  • # Subject applied to appointments booked through this schedule.
  • appointmentSubject: EntityFilterStringField
  • # When true, booked appointments use the scheduleName as their subject instead of
  • # appointmentSubject.
  • appointmentSubjectUsesScheduleName: Boolean
  • # Id of the appointment type used for appointments booked through the schedule.
  • appointmentTypeId: EntityFilterStringField
  • # IANA timezone (e.g. "Europe/Bratislava") in which availability windows are
  • # defined.
  • availabilityTzid: EntityFilterStringField
  • # Buffer in seconds kept free after each booked appointment (e.g. 900 = 15
  • # minutes).
  • bufferTimeAfter: EntityFilterNumberField
  • # Buffer in seconds kept free before each booked appointment (e.g. 900 = 15
  • # minutes).
  • bufferTimeBefore: EntityFilterNumberField
  • # What is shown to the booker after confirming (e.g. default Coevera page or a
  • # custom redirect URL).
  • confirmationPageType: AppointmentScheduleConfirmationPageTypeEnumFilterInput
  • # Custom URL the booker is redirected to after confirming. Used when
  • # confirmationPageType selects a custom redirect.
  • confirmationPageUrl: EntityFilterStringField
  • # Master switch for the schedule. Disabled schedules do not accept new bookings.
  • isEnabled: Boolean
  • # Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one
  • # hour).
  • minimumNoticeTime: EntityFilterNumberField
  • # Admin-only name for the schedule, used in pickers and lists. Not shown to
  • # bookers; use scheduleName for the public-facing name.
  • name: EntityFilterStringField
  • # Id of the schedule owner.
  • ownerId: EntityFilterStringField
  • # With Offset planning, how many days ahead the schedule remains bookable.
  • planningDayOffset: EntityFilterNumberField
  • # Time window in which the schedule accepts bookings: any future date (Infinite),
  • # up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and
  • # planningPeriodTo (Period).
  • planningType: AppointmentSchedulePlanningTypeEnumFilterInput
  • # True when a reminder email is sent to invitees ahead of the booked appointment.
  • reminderEmailEnabled: Boolean
  • # Time before the appointment when the reminder email is sent. Interpreted using
  • # reminderEmailOffsetType.
  • reminderEmailOffset: EntityFilterNumberField
  • # Time unit of reminderEmailOffset: Minute, Hour, Day or Week.
  • reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnumFilterInput
  • # Id of the company email used as the From / Reply-To on schedule confirmation
  • # emails. Empty falls back to the team space default.
  • replyCompanyEmailId: EntityFilterStringField
  • # Public-facing name of the schedule, shown to bookers on the booking page.
  • scheduleName: EntityFilterStringField
  • # Step in seconds between offered start times (e.g. 900 means slots at :00, :15,
  • # :30, :45).
  • timeIncrement: EntityFilterNumberField
  • # Kind of meetings booked through the schedule: one-to-one (OneToOne) or group
  • # (Group) meetings.
  • type: AppointmentScheduleTypeEnumFilterInput
  • # Public URL slug of the schedule, used to share the booking page.
  • url: EntityFilterStringField
  • # User assigned as the appointment owner when a booking is made through this
  • # schedule. Matches records where a related record meets these conditions.
  • appointmentOwner: ClientFilterInput
  • # Appointment type used when a booking is created. Matches records where a related
  • # record meets these conditions.
  • appointmentType: AppointmentTypeFilterInput
  • # Owner of the schedule (typically the team member whose availability is exposed).
  • # Matches records where a related record meets these conditions.
  • owner: ClientFilterInput
  • # Sender company email used as the From / Reply-To on schedule confirmation
  • # emails. Empty falls back to the team space default. Matches records where a
  • # related record meets these conditions.
  • replyCompanyEmail: CompanyEmailFilterInput
  • }