Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriesappointmentSchedule

entities.appointmentSchedule

Read appointment schedule records with the appointmentSchedule repository, and change them with the appointment schedule mutations. Same records as the REST AppointmentSchedules entity.

Queries

Fields of entities { appointmentSchedule { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
AppointmentScheduleEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[AppointmentScheduleEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: AppointmentScheduleFilterInput, orderBy: [AppointmentScheduleOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[AppointmentScheduleEntity!]!
QUERYgetByCriteria(filter: AppointmentScheduleFilterInput, orderBy: [AppointmentScheduleOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
AppointmentScheduleEntityConnection
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!

Mutations

KindMutationDoesReturns
MUTATIONcreateAppointmentSchedule(input: CreateAppointmentScheduleInput!, validationLevel: [ValidationLevel!])Create one recordCreateAppointmentSchedulePayload
MUTATIONupdateAppointmentSchedule(input: UpdateAppointmentScheduleInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateAppointmentSchedulePayload
MUTATIONbulkUpdateAppointmentSchedule(input: [CreateOrUpdateAppointmentScheduleInput!]!, deleteInput: [DeleteAppointmentScheduleInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateAppointmentSchedulePayload
MUTATIONdeleteAppointmentSchedule(input: DeleteAppointmentScheduleInput!)Soft-deleteDeleteAppointmentSchedulePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

AppointmentScheduleEntity object 47 fields: isDeleteProtected, id, isDeleted, …

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

FieldTypeDescription
isDeleteProtectedBoolean!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.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentOwnerClientEntityUser assigned as the appointment owner when a booking is made through this schedule.
appointmentTypeAppointmentTypeEntityAppointment type used when a booking is created.
ownerClientEntityOwner of the schedule (typically the team member whose availability is exposed).
replyCompanyEmailCompanyEmailEntitySender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
appointmentDescriptionString!Description applied to appointments booked through this schedule.
appointmentDurationFloatDuration of each booked appointment.
appointmentLocationString!Location applied to appointments booked through this schedule.
appointmentLocationTypeAppointmentScheduleLocationTypeEnumWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdID!Id of the user receiving the booking.
appointmentSubjectString!Subject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameBoolean!When true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdID!Id of the appointment type used for appointments booked through the schedule.
availabilityTzidStringIANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
bufferTimeAfterInt!Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeInt!Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeAppointmentScheduleConfirmationPageTypeEnumWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlStringCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledBoolean!Master switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeInt!Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameString!Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdID!Id of the schedule owner.
planningDayOffsetInt!With Offset planning, how many days ahead the schedule remains bookable.
planningPeriodFromDateWith Period planning, first date bookings are accepted for.
planningPeriodToDateWith Period planning, last date bookings are accepted for.
planningTypeAppointmentSchedulePlanningTypeEnumTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledBoolean!True when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetInt!Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeAppointmentScheduleReminderOffsetTypeEnumTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdIDId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameString!Public-facing name of the schedule, shown to bookers on the booking page.
timeIncrementInt!Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeAppointmentScheduleTypeEnumKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlString!Public URL slug of the schedule, used to share the booking page.
additionalFieldsData[AppointmentScheduleAdditionalField!]!Custom fields the booker is asked to fill in on the booking page, in display order.
availabilityDataAppointmentScheduleAvailability!Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone.
appointmentInviteesData[AppointmentScheduleInvitee!]!Default invitees added to appointments booked through this schedule (Coevera users or external email addresses).
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
availableSlots[DateTime!]! (3 args)Start times of the free booking slots the schedule offers between the two dates. Empty when the schedule is disabled.
createdAppointmentsCountInt!Number of appointments booked through this schedule.
upcomingAppointmentsCountInt!Number of appointments booked through this schedule that are not finished.
completedAppointmentsCountInt!Number of appointments booked through this schedule that were completed.
canceledAppointmentsCountInt!Number of appointments booked through this schedule that were canceled.
AppointmentScheduleEntityConnection object pageInfo: PageInfo!, edges: [AppointmentScheduleEntityEdge]!, totalCount: Int

Paginated list of AppointmentSchedule records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[AppointmentScheduleEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
AppointmentScheduleEntityEdge object node: AppointmentScheduleEntity, cursor: String!

A Relay edge containing a AppointmentScheduleEntity and its cursor.

FieldTypeDescription
nodeAppointmentScheduleEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
AppointmentScheduleConfirmationPageTypeEnumFilterInput input eq: [AppointmentScheduleConfirmationPageTypeEnum!], NOT: AppointmentScheduleConfirmationPageTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AppointmentScheduleConfirmationPageTypeEnum!]Matches any of the listed values.
NOTAppointmentScheduleConfirmationPageTypeEnumFilterInputMatches values that do not meet this condition.
AppointmentScheduleFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input fieldTypeDescription
OR[AppointmentScheduleFilterInput!]Matches records that meet at least one of the listed filters.
AND[AppointmentScheduleFilterInput!]Matches records that meet all of the listed filters.
NOTAppointmentScheduleFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
appointmentDescriptionEntityFilterStringFieldDescription applied to appointments booked through this schedule.
appointmentDurationEntityFilterNumberFieldDuration of each booked appointment.
appointmentLocationEntityFilterStringFieldLocation applied to appointments booked through this schedule.
appointmentLocationTypeAppointmentScheduleLocationTypeEnumFilterInputWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdEntityFilterStringFieldId of the user receiving the booking.
appointmentSubjectEntityFilterStringFieldSubject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameBooleanWhen true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdEntityFilterStringFieldId of the appointment type used for appointments booked through the schedule.
availabilityTzidEntityFilterStringFieldIANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
bufferTimeAfterEntityFilterNumberFieldBuffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeEntityFilterNumberFieldBuffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeAppointmentScheduleConfirmationPageTypeEnumFilterInputWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlEntityFilterStringFieldCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledBooleanMaster switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeEntityFilterNumberFieldMinimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameEntityFilterStringFieldAdmin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdEntityFilterStringFieldId of the schedule owner.
planningDayOffsetEntityFilterNumberFieldWith Offset planning, how many days ahead the schedule remains bookable.
planningTypeAppointmentSchedulePlanningTypeEnumFilterInputTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledBooleanTrue when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetEntityFilterNumberFieldTime before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeAppointmentScheduleReminderOffsetTypeEnumFilterInputTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdEntityFilterStringFieldId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameEntityFilterStringFieldPublic-facing name of the schedule, shown to bookers on the booking page.
timeIncrementEntityFilterNumberFieldStep in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeAppointmentScheduleTypeEnumFilterInputKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlEntityFilterStringFieldPublic URL slug of the schedule, used to share the booking page.
appointmentOwnerClientFilterInputUser assigned as the appointment owner when a booking is made through this schedule. Matches records where a related record meets these conditions.
appointmentTypeAppointmentTypeFilterInputAppointment type used when a booking is created. Matches records where a related record meets these conditions.
ownerClientFilterInputOwner of the schedule (typically the team member whose availability is exposed). Matches records where a related record meets these conditions.
replyCompanyEmailCompanyEmailFilterInputSender 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.
AppointmentScheduleLocationTypeEnumFilterInput input eq: [AppointmentScheduleLocationTypeEnum!], NOT: AppointmentScheduleLocationTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AppointmentScheduleLocationTypeEnum!]Matches any of the listed values.
NOTAppointmentScheduleLocationTypeEnumFilterInputMatches values that do not meet this condition.
AppointmentScheduleOrderByInput input Asc or Desc per field

Sorting of AppointmentSchedule records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
appointmentOwner[ClientOrderByNestedInput!]User assigned as the appointment owner when a booking is made through this schedule. Sorts by fields of the related record, listed in order of priority.
appointmentType[AppointmentTypeOrderByNestedInput!]Appointment type used when a booking is created. Sorts by fields of the related record, listed in order of priority.
owner[ClientOrderByNestedInput!]Owner of the schedule (typically the team member whose availability is exposed). Sorts by fields of the related record, listed in order of priority.
replyCompanyEmail[CompanyEmailOrderByNestedInput!]Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. Sorts by fields of the related record, listed in order of priority.
appointmentDescriptionOrderByEnumDescription applied to appointments booked through this schedule.
appointmentDurationOrderByEnumDuration of each booked appointment.
appointmentLocationOrderByEnumLocation applied to appointments booked through this schedule.
appointmentLocationTypeOrderByEnumWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdOrderByEnumId of the user receiving the booking.
appointmentSubjectOrderByEnumSubject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameOrderByEnumWhen true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdOrderByEnumId of the appointment type used for appointments booked through the schedule.
bufferTimeAfterOrderByEnumBuffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeOrderByEnumBuffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeOrderByEnumWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlOrderByEnumCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledOrderByEnumMaster switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeOrderByEnumMinimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameOrderByEnumAdmin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdOrderByEnumId of the schedule owner.
planningDayOffsetOrderByEnumWith Offset planning, how many days ahead the schedule remains bookable.
planningPeriodFromOrderByEnumWith Period planning, first date bookings are accepted for.
planningPeriodToOrderByEnumWith Period planning, last date bookings are accepted for.
planningTypeOrderByEnumTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledOrderByEnumTrue when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetOrderByEnumTime before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeOrderByEnumTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdOrderByEnumId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameOrderByEnumPublic-facing name of the schedule, shown to bookers on the booking page.
timeIncrementOrderByEnumStep in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeOrderByEnumKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlOrderByEnumPublic URL slug of the schedule, used to share the booking page.
AppointmentSchedulePlanningTypeEnumFilterInput input eq: [AppointmentSchedulePlanningTypeEnum!], NOT: AppointmentSchedulePlanningTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AppointmentSchedulePlanningTypeEnum!]Matches any of the listed values.
NOTAppointmentSchedulePlanningTypeEnumFilterInputMatches values that do not meet this condition.
AppointmentScheduleReminderOffsetTypeEnumFilterInput input eq: [AppointmentScheduleReminderOffsetTypeEnum!], NOT: AppointmentScheduleReminderOffsetTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AppointmentScheduleReminderOffsetTypeEnum!]Matches any of the listed values.
NOTAppointmentScheduleReminderOffsetTypeEnumFilterInputMatches values that do not meet this condition.
AppointmentScheduleTypeEnumFilterInput input eq: [AppointmentScheduleTypeEnum!], NOT: AppointmentScheduleTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AppointmentScheduleTypeEnum!]Matches any of the listed values.
NOTAppointmentScheduleTypeEnumFilterInputMatches values that do not meet this condition.
AppointmentScheduleAdditionalFieldParams input fieldId: ID!, label: String!, isRequired: Boolean!

Appointment field the booker fills in on the booking page of an appointment schedule.

Input fieldTypeDescription
fieldIdID!Id of the appointment field the booker fills in; the value is saved on the booked appointment.
labelString!Label of the field on the booking page.
isRequiredBoolean!True when the booker must fill in the field.
AppointmentScheduleAvailabilityParams input 7 fields: monday, tuesday, wednesday, …

Weekly availability of an appointment schedule: the time windows in which appointments can be booked on each weekday.

Input fieldTypeDescription
mondayAppointmentScheduleDayAvailabilityParams!Availability on Mondays.
tuesdayAppointmentScheduleDayAvailabilityParams!Availability on Tuesdays.
wednesdayAppointmentScheduleDayAvailabilityParams!Availability on Wednesdays.
thursdayAppointmentScheduleDayAvailabilityParams!Availability on Thursdays.
fridayAppointmentScheduleDayAvailabilityParams!Availability on Fridays.
saturdayAppointmentScheduleDayAvailabilityParams!Availability on Saturdays.
sundayAppointmentScheduleDayAvailabilityParams!Availability on Sundays.
AppointmentScheduleAvailabilitySlotParams input start: Int!, end: Int!

Time window of a day in which appointments can be booked.

Input fieldTypeDescription
startInt!Start of the time window, in seconds after midnight (e.g. 32400 for 09:00) in the availabilityTzid timezone of the schedule.
endInt!End of the time window, in seconds after midnight. A booked appointment, including its buffer times, must fit inside one window.
AppointmentScheduleDayAvailabilityParams input isEnabled: Boolean!, slots: [AppointmentScheduleAvailabilitySlotParams!]!

Availability of an appointment schedule on one weekday.

Input fieldTypeDescription
isEnabledBoolean!True when bookings can be made on this weekday; when false, the slots are ignored.
slots[AppointmentScheduleAvailabilitySlotParams!]!Time windows of the day in which bookings can be made; overlapping windows are merged.
AppointmentScheduleInviteeParams input type: AppointmentScheduleInviteeType!, email: String!, entityId: ID

Default invitee of an appointment schedule: a Coevera user, a contact or an external email address.

Input fieldTypeDescription
typeAppointmentScheduleInviteeType!Kind of invitee: a Coevera user (Client), a contact (Contact) or an external email address (Email). Only Client invitees are added to booked appointments.
emailString!Email address of the invitee.
entityIdIDId of the user or contact; empty for an Email invitee.
CreateAppointmentScheduleInput input 35 fields: clientMutationId, modified, created, …

Field values of a new AppointmentSchedule record.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentDescriptionString!Description applied to appointments booked through this schedule.
appointmentDurationFloatDuration of each booked appointment.
appointmentLocationString!Location applied to appointments booked through this schedule.
appointmentLocationTypeAppointmentScheduleLocationTypeEnumWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdID!Id of the user receiving the booking.
appointmentSubjectString!Subject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameBoolean!When true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdID!Id of the appointment type used for appointments booked through the schedule.
availabilityTzidStringIANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
bufferTimeAfterInt!Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeInt!Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeAppointmentScheduleConfirmationPageTypeEnumWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlStringCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledBoolean!Master switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeInt!Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameString!Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdID!Id of the schedule owner.
planningDayOffsetInt!With Offset planning, how many days ahead the schedule remains bookable.
planningPeriodFromDateWith Period planning, first date bookings are accepted for.
planningPeriodToDateWith Period planning, last date bookings are accepted for.
planningTypeAppointmentSchedulePlanningTypeEnumTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledBoolean!True when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetInt!Time before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeAppointmentScheduleReminderOffsetTypeEnumTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdIDId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameString!Public-facing name of the schedule, shown to bookers on the booking page.
timeIncrementInt!Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeAppointmentScheduleTypeEnumKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlString!Public URL slug of the schedule, used to share the booking page.
additionalFieldsData[AppointmentScheduleAdditionalFieldParams!]!Custom fields the booker is asked to fill in on the booking page, in display order.
availabilityDataAppointmentScheduleAvailabilityParams!Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone.
appointmentInviteesData[AppointmentScheduleInviteeParams!]!Default invitees added to appointments booked through this schedule (Coevera users or external email addresses).
CreateOrUpdateAppointmentScheduleInput input 36 fields: clientMutationId, id, modified, …

Field values of an AppointmentSchedule record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentDescriptionStringDescription applied to appointments booked through this schedule.
appointmentDurationFloatDuration of each booked appointment.
appointmentLocationStringLocation applied to appointments booked through this schedule.
appointmentLocationTypeAppointmentScheduleLocationTypeEnumWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdIDId of the user receiving the booking.
appointmentSubjectStringSubject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameBooleanWhen true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdIDId of the appointment type used for appointments booked through the schedule.
availabilityTzidStringIANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
bufferTimeAfterIntBuffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeIntBuffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeAppointmentScheduleConfirmationPageTypeEnumWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlStringCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledBooleanMaster switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeIntMinimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameStringAdmin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdIDId of the schedule owner.
planningDayOffsetIntWith Offset planning, how many days ahead the schedule remains bookable.
planningPeriodFromDateWith Period planning, first date bookings are accepted for.
planningPeriodToDateWith Period planning, last date bookings are accepted for.
planningTypeAppointmentSchedulePlanningTypeEnumTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledBooleanTrue when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetIntTime before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeAppointmentScheduleReminderOffsetTypeEnumTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdIDId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameStringPublic-facing name of the schedule, shown to bookers on the booking page.
timeIncrementIntStep in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeAppointmentScheduleTypeEnumKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlStringPublic URL slug of the schedule, used to share the booking page.
additionalFieldsData[AppointmentScheduleAdditionalFieldParams!]Custom fields the booker is asked to fill in on the booking page, in display order.
availabilityDataAppointmentScheduleAvailabilityParamsWeekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone.
appointmentInviteesData[AppointmentScheduleInviteeParams!]Default invitees added to appointments booked through this schedule (Coevera users or external email addresses).
DeleteAppointmentScheduleInput input clientMutationId: String, id: ID!

Id of the AppointmentSchedule record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
UpdateAppointmentScheduleInput input 36 fields: clientMutationId, id, modified, …

Id of an AppointmentSchedule record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentDescriptionStringDescription applied to appointments booked through this schedule.
appointmentDurationFloatDuration of each booked appointment.
appointmentLocationStringLocation applied to appointments booked through this schedule.
appointmentLocationTypeAppointmentScheduleLocationTypeEnumWhere booked appointments take place: the location given in appointmentLocation (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.
appointmentOwnerIdIDId of the user receiving the booking.
appointmentSubjectStringSubject applied to appointments booked through this schedule.
appointmentSubjectUsesScheduleNameBooleanWhen true, booked appointments use the scheduleName as their subject instead of appointmentSubject.
appointmentTypeIdIDId of the appointment type used for appointments booked through the schedule.
availabilityTzidStringIANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
bufferTimeAfterIntBuffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).
bufferTimeBeforeIntBuffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).
confirmationPageTypeAppointmentScheduleConfirmationPageTypeEnumWhat is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).
confirmationPageUrlStringCustom URL the booker is redirected to after confirming. Used when confirmationPageType selects a custom redirect.
isEnabledBooleanMaster switch for the schedule. Disabled schedules do not accept new bookings.
minimumNoticeTimeIntMinimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour).
nameStringAdmin-only name for the schedule, used in pickers and lists. Not shown to bookers; use scheduleName for the public-facing name.
ownerIdIDId of the schedule owner.
planningDayOffsetIntWith Offset planning, how many days ahead the schedule remains bookable.
planningPeriodFromDateWith Period planning, first date bookings are accepted for.
planningPeriodToDateWith Period planning, last date bookings are accepted for.
planningTypeAppointmentSchedulePlanningTypeEnumTime window in which the schedule accepts bookings: any future date (Infinite), up to planningDayOffset days ahead (Offset), or between planningPeriodFrom and planningPeriodTo (Period).
reminderEmailEnabledBooleanTrue when a reminder email is sent to invitees ahead of the booked appointment.
reminderEmailOffsetIntTime before the appointment when the reminder email is sent. Interpreted using reminderEmailOffsetType.
reminderEmailOffsetTypeAppointmentScheduleReminderOffsetTypeEnumTime unit of reminderEmailOffset: Minute, Hour, Day or Week.
replyCompanyEmailIdIDId of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.
scheduleNameStringPublic-facing name of the schedule, shown to bookers on the booking page.
timeIncrementIntStep in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45).
typeAppointmentScheduleTypeEnumKind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.
urlStringPublic URL slug of the schedule, used to share the booking page.
additionalFieldsData[AppointmentScheduleAdditionalFieldParams!]Custom fields the booker is asked to fill in on the booking page, in display order.
availabilityDataAppointmentScheduleAvailabilityParamsWeekly availability windows (per weekday) used to compute bookable slots, in the schedule's availabilityTzid timezone.
appointmentInviteesData[AppointmentScheduleInviteeParams!]Default invitees added to appointments booked through this schedule (Coevera users or external email addresses).
BulkUpdateAppointmentSchedulePayload object result: BulkUpdateResults!

Result of the bulkUpdateAppointmentSchedule mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
CreateAppointmentSchedulePayload object appointmentSchedule: AppointmentScheduleEntity, clientMutationId: String

Result of the createAppointmentSchedule mutation.

FieldTypeDescription
appointmentScheduleAppointmentScheduleEntityThe created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
DeleteAppointmentSchedulePayload object appointmentSchedule: AppointmentScheduleEntity, clientMutationId: String

Result of the deleteAppointmentSchedule mutation.

FieldTypeDescription
appointmentScheduleAppointmentScheduleEntityThe deleted record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateAppointmentSchedulePayload object appointmentSchedule: AppointmentScheduleEntity, clientMutationId: String

Result of the updateAppointmentSchedule mutation.

FieldTypeDescription
appointmentScheduleAppointmentScheduleEntityThe updated record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
AppointmentScheduleAdditionalField object fieldId: ID!, label: String!, isRequired: Boolean!

Appointment field the booker fills in on the booking page of an appointment schedule.

FieldTypeDescription
fieldIdID!Id of the appointment field the booker fills in; the value is saved on the booked appointment.
labelString!Label of the field on the booking page.
isRequiredBoolean!True when the booker must fill in the field.
AppointmentScheduleAvailability object 7 fields: monday, tuesday, wednesday, …

Weekly availability of an appointment schedule: the time windows in which appointments can be booked on each weekday.

FieldTypeDescription
mondayAppointmentScheduleDayAvailability!Availability on Mondays.
tuesdayAppointmentScheduleDayAvailability!Availability on Tuesdays.
wednesdayAppointmentScheduleDayAvailability!Availability on Wednesdays.
thursdayAppointmentScheduleDayAvailability!Availability on Thursdays.
fridayAppointmentScheduleDayAvailability!Availability on Fridays.
saturdayAppointmentScheduleDayAvailability!Availability on Saturdays.
sundayAppointmentScheduleDayAvailability!Availability on Sundays.
AppointmentScheduleAvailabilitySlot object start: Int!, end: Int!

Time window of a day in which appointments can be booked.

FieldTypeDescription
startInt!Start of the time window, in seconds after midnight (e.g. 32400 for 09:00) in the availabilityTzid timezone of the schedule.
endInt!End of the time window, in seconds after midnight. A booked appointment, including its buffer times, must fit inside one window.
AppointmentScheduleConfirmationPageTypeEnum enum ConfirmationPage, ExternalUrl

What the booker sees after confirming a booking.

ValueDescription
ConfirmationPageThe built-in confirmation page is shown.
ExternalUrlThe booker is redirected to confirmationPageUrl.
AppointmentScheduleDayAvailability object isEnabled: Boolean!, slots: [AppointmentScheduleAvailabilitySlot!]!

Availability of an appointment schedule on one weekday.

FieldTypeDescription
isEnabledBoolean!True when bookings can be made on this weekday; when false, the slots are ignored.
slots[AppointmentScheduleAvailabilitySlot!]!Time windows of the day in which bookings can be made; overlapping windows are merged.
AppointmentScheduleInvitee object type: AppointmentScheduleInviteeType!, email: String!, entityId: ID

Default invitee of an appointment schedule: a Coevera user, a contact or an external email address.

FieldTypeDescription
typeAppointmentScheduleInviteeType!Kind of invitee: a Coevera user (Client), a contact (Contact) or an external email address (Email). Only Client invitees are added to booked appointments.
emailString!Email address of the invitee.
entityIdIDId of the user or contact; empty for an Email invitee.
AppointmentScheduleInviteeType enum Client, Contact, Email

Kind of default invitee of an appointment schedule.

ValueDescription
ClientCoevera user; entityId identifies the user.
ContactContact; entityId identifies the contact.
EmailExternal email address given in email.
AppointmentScheduleLocationTypeEnum enum Custom, Microsoft, Zoom

Where meetings booked through an appointment schedule take place.

ValueDescription
CustomLocation given in appointmentLocation.
MicrosoftMicrosoft Teams online meeting.
ZoomZoom online meeting.
AppointmentSchedulePlanningTypeEnum enum Infinite, Offset, Period

Time window in which an appointment schedule accepts bookings.

ValueDescription
InfiniteBookings are accepted for any future date.
OffsetBookings are accepted up to planningDayOffset days ahead.
PeriodBookings are accepted only between planningPeriodFrom and planningPeriodTo.
AppointmentScheduleReminderOffsetTypeEnum enum Minute, Hour, Day, Week

Time unit of the reminder email offset of an appointment schedule.

ValueDescription
MinuteOffset measured in minutes.
HourOffset measured in hours.
DayOffset measured in days.
WeekOffset measured in weeks.
AppointmentScheduleTypeEnum enum OneToOne, Group

Kind of meeting booked through an appointment schedule.

ValueDescription
OneToOneThe booker meets only the schedule owner.
GroupThe booker meets the schedule owner together with their team members at the same time.