OBJECT
AppointmentScheduleEntity

Online booking link through which people book appointments with a user in the time slots the user has available.
GraphQL Schema definition

type AppointmentScheduleEntity {
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
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! 
# Where booked appointments take place: the location given in appointmentLocation 
# (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
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 scheduleName as their subject instead of 
# appointmentSubject.
appointmentSubjectUsesScheduleName: Boolean! 
# Id of the appointment type used for appointments booked through the schedule.
appointmentTypeId: ID! 
# IANA timezone (e.g. "Europe/Bratislava") in which availability windows are 
# defined.
availabilityTzid: String 
# Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 
# minutes).
bufferTimeAfter: Int! 
# Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 
# minutes).
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 
# confirmationPageType selects a custom redirect.
confirmationPageUrl: String 
# 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: Int! 
# Admin-only name for the schedule, used in pickers and lists. Not shown to 
# bookers; use scheduleName for the public-facing name.
name: String! 
# Id of the schedule owner.
ownerId: ID! 
# With Offset planning, how many days ahead the schedule remains bookable.
planningDayOffset: Int! 
# With Period planning, first date bookings are accepted for.
planningPeriodFrom: Date 
# With Period planning, last date bookings are accepted for.
planningPeriodTo: Date 
# 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: 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 
# reminderEmailOffsetType.
reminderEmailOffset: Int! 
# Time unit of reminderEmailOffset: Minute, Hour, Day or Week.
reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum 
# Id of the company email used as the From / Reply-To on schedule confirmation 
# emails. Empty falls back to the team space default.
replyCompanyEmailId: ID 
# Public-facing name of the schedule, shown to bookers on the booking page.
scheduleName: String! 
# Step in seconds between offered start times (e.g. 900 means slots at :00, :15, 
# :30, :45).
timeIncrement: Int! 
# Kind of meetings booked through the schedule: one-to-one (OneToOne) or group 
# (Group) meetings.
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 availabilityTzid timezone.
availabilityData: AppointmentScheduleAvailability! 
# Default invitees added to appointments booked through this schedule (Pipeliner 
# users or external email addresses).
appointmentInviteesData: [AppointmentScheduleInvitee!]! 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Start times of the free booking slots the schedule offers between the two dates. 
# Empty when the schedule is disabled.
# 
# Arguments
# tzId: IANA time zone the returned start times are expressed in.
# from: First day of the range, inclusive.
# to: Last day of the range, inclusive.
availableSlots(tzId: String!, from: Date!, to: Date!): [DateTime!]! 
# Number of appointments booked through this schedule.
createdAppointmentsCount: Int! 
# Number of appointments booked through this schedule that are not finished.
upcomingAppointmentsCount: Int! 
# Number of appointments booked through this schedule that were completed.
completedAppointmentsCount: Int! 
# Number of appointments booked through this schedule that were canceled.
canceledAppointmentsCount: Int! 
}
AppointmentScheduleEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
