Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Schedule Object

Attributes

NAME
TYPE
DESCRIPTION
rate

object

The price options offered to book this schedule's slots. Optional. The default is no rate.

location

object

Geographic location of the session as free-form text. Optional. This is the default location of the schedule's sessions.

calendarConference

object

A conference meeting created for the schedule. This is used when a participant is added to a schedule.

firstSessionStart

string

The start time of the schedule. Read only. calculated by the start time of the first session.

scheduleOwnerId

string

The id of the schedule's owner. e.g, in case of schedule of a service, service id.

intervals

Array<object>

Specifies the intervals for the sessions calculation. Optional. e.g. when creating class service you can add pattern for recurring intervals, these intervals can be returned as schedule's sessions or available slots if there are no other availability calculation constraints and the capacity is bigger then the current total number of sessions' participants.

tags

Array<string>

Tags of the schedule. Optional. e.g., tag as service type. Google sessions tag as "Google". This is the default tags of the schedule's sessions.

participants

Array<object>

The registered participants of this schedule. Read only. Can be added using Schedules service using the Participants apis.

availability

object

Describes how to calculate the schedule's availability for adding participants. Optional. Empty value indicates that this schedule is not available for adding participants. This definition will be applied to the schedule's available intervals. Schedule's available intervals are the recurring intervals minus sessions that has no more spots, or schedule's sessions with open spots.

lastSessionEnd

string

The end time of the schedule. Read only. calculated by the end time of the last session.

version

integer

the schedule's version

id

string

Schedule identifier.

updated

string

The time when this schedule was last modified.

inheritedFields

Array<string>

A list of fields for which values were inherited from the business.

status

string

Supported values: UNDEFINED, CREATED, CANCELLED.

The schedule's status. Optional. Possible values are: CREATED, This is the default status. CANCELLED, the schedule was cancelled.

totalNumberOfParticipants

integer

The current number of registered participants on this schedule when this schedule is a bookable slot. Read only. calculated by the number of participants plus the additional participants.

conferenceProvider

object

Conferencing Provider. A schedule with a conferencing provider will use to provider information to create a conference meeting on the provider's system when a session is created on the schedule or on one of its linked schedule's.

externalCalendarOverrides

object

Optional. When provided, the values will be used to override default fields values which are synced to external calendar. Read more in external calendar documentation.

title

string

The textual title of the schedule. Optional. This is the default title of the schedule's sessions. i.e., a service name. Max length: 6000.

timeZone

string

The time zone of the schedule. Optional.

created

string

The time when this schedule was created.

capacity

integer

The maximum number of participants that can be added to this schedule's slots. Optional. The default is 1. This is the default capacity of the schedule's sessions. minimum: 1, maximum: 1000

Was this helpful?