OBJECT
AppointmentScheduleEntity

GraphQL Schema definition

type AppointmentScheduleEntity {
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
#   Unique identifier of entity.
id: ID! 
#   Specifies if the entity is considered deleted.
isDeleted: Boolean 
#   Last modification time.
modified: DateTime 
#   Creation time.
created: DateTime 
#   User assigned as the appointment owner when a booking is made through this 
#   schedule.
appointmentOwner: ClientEntity 
#   Appointment type used when a booking is created.
appointmentType: AppointmentTypeEntity 
#   Owner of the schedule (typically the team member whose availability is exposed).
owner: ClientEntity 
#   Sender company email used as the From / Reply-To on schedule confirmation 
#   emails. Empty falls back to the team space default.
replyCompanyEmail: CompanyEmailEntity 
#   Description applied to appointments booked through this schedule.
appointmentDescription: String! 
#   Duration of each booked appointment.
appointmentDuration: Float 
#   Location applied to appointments booked through this schedule.
appointmentLocation: String! 
#   How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).
appointmentLocationType: AppointmentScheduleLocationTypeEnum 
#   Id of the user receiving the booking.
appointmentOwnerId: ID! 
#   Subject applied to appointments booked through this schedule.
appointmentSubject: String! 
#   When true, booked appointments use the schedule_name as their subject instead of 
#   appointment_subject.
appointmentSubjectUsesScheduleName: Boolean! 
#   Id of the appointment type.
appointmentTypeId: ID! 
#   IANA timezone (e.g. "Europe/Bratislava") in which availability windows are 
#   defined.
availabilityTzid: String 
#   Minutes of buffer reserved after each booked appointment.
bufferTimeAfter: Int! 
#   Minutes of buffer reserved before each booked appointment.
bufferTimeBefore: Int! 
#   What is shown to the booker after confirming (e.g. default Coevera page or a 
#   custom redirect URL).
confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum 
#   Custom URL the booker is redirected to after confirming. Used when 
#   confirmation_page_type selects a custom redirect.
confirmationPageUrl: String 
#   Master switch for the schedule. Disabled schedules do not accept new bookings.
isEnabled: Boolean! 
#   Minimum notice in hours required before a slot can be booked.
minimumNoticeTime: Int! 
#   Admin-only name for the schedule, used in pickers and lists. Not shown to 
#   bookers; use schedule_name for the public-facing name.
name: String! 
#   Id of the schedule owner.
ownerId: ID! 
#   For rolling planning: how many days ahead the schedule remains bookable.
planningDayOffset: Int! 
#   For fixed-range planning: first date bookings are accepted for.
planningPeriodFrom: Date 
#   For fixed-range planning: last date bookings are accepted for.
planningPeriodTo: Date 
#   How far ahead bookings are accepted (e.g. RollingDays, FixedRange).
planningType: AppointmentSchedulePlanningTypeEnum 
#   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 
#   reminder_email_offset_type.
reminderEmailOffset: Int! 
#   Unit of reminder_email_offset (e.g. Minutes, Hours, Days).
reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum 
#   Id of the reply company email.
replyCompanyEmailId: ID 
#   Public-facing name of the schedule, shown to bookers on the booking page.
scheduleName: String! 
#   Step in minutes between offered start times (e.g. 15 means slots at :00, :15, 
#   :30, :45).
timeIncrement: Int! 
#   Schedule type (e.g. one-on-one or round-robin).
type: AppointmentScheduleTypeEnum 
#   Public URL slug of the schedule, used to share the booking page.
url: String! 
#   Custom fields the booker is asked to fill in on the booking page, in display 
#   order.
additionalFieldsData: [AppointmentScheduleAdditionalField!]! 
#   Weekly availability windows (per weekday) used to compute bookable slots, in the 
#   schedule's availability_tzid timezone.
availabilityData: AppointmentScheduleAvailability! 
#   Default invitees added to appointments booked through this schedule (Pipeliner 
#   users or external email addresses).
appointmentInviteesData: [AppointmentScheduleInvitee!]! 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Arguments
#   tzId: [Not documented]
#   from: [Not documented]
#   to: [Not documented]
availableSlots(tzId: String!, from: Date!, to: Date!): [DateTime!]! 
createdAppointmentsCount: Int! 
upcomingAppointmentsCount: Int! 
completedAppointmentsCount: Int! 
canceledAppointmentsCount: Int! 
}
AppointmentScheduleEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
