Query Sessions

Session Object

Properties

idstringRead-only

Session ID.

scheduleIdstring

ID of the schedule that the session belongs to.

scheduleOwnerIdstringRead-only

ID of the resource or service that the session's schedule belongs to.

originalStartstringformat date-time

Original start date and time of the session in ISO 8601 format.

startobject

An object specifying the start date and time of the session. If the session is a recurring session, start must contain a localDateTime.

endobject

An object specifying the end date and time of the session. The end time must be after the start time and be same type as start. If the session is a recurring session, end must contain a localDateTime.

affectedSchedulesArray <LinkedSchedule>

An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct. The array is inherited from the schedule and can be overridden even if the session is a recurring session.

titlestringmaxLength 6000

Session title. The value is inherited from the schedule and can be overridden unless the session is a recurring session.

tagsstringmaxLength 200

Tags for the session. The value is inherited from the schedule and can be overridden unless the session is a recurring session.

locationobject

An object describing the location where the session takes place. Defaults to the schedule location. For single sessions, session.location.businessLocation can only be provided for locations that are defined in the schedule using schedule.location or schedule.availability.locations.

capacityintegerminimum 0maximum 1000format int32

Maximum number of participants that can be added to the session. Defaults to the schedule capacity. The value is inherited from the schedule and can be overridden unless the session is a recurring session.

rateobject

Deprecated. Please use the Booking Services V2 payment instead.

timeReservedAfterintegerformat int32

Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only. If the session is a recurring session, this field must be empty.

notesstringmaxLength 10000

Additional information about the session. Notes are not supported for recurring sessions.

totalNumberOfParticipantsintegerRead-only

The number of participants booked for the session. Read-only. Calculated as the sum of the party sizes.

participantsArray <Participant>

Partial list* list of participants booked for the session. The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session. If the session is a recurring session, this field must be empty. To retrieve the full list of session participants please use the Query Extended Bookings API.

inheritedFieldsArray <string>Read-only

A list of properties for which values were inherited from the schedule. This does not include participants that were inherited from the schedule.

externalCalendarOverridesobject

Deprecated and will be removed soon.

statusstringRead-only

3 enum supported values:

UNDEFINEDCONFIRMEDCANCELLED

Session status.

recurringIntervalIdstringRead-only

Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional. For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions. This field is omitted for single sessions or instances of recurring sessions. Specified when the session was originally generated from a schedule recurring interval. Deprecated. Use recurringSessionId.

recurringSessionIdstringRead-only

The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.

typestring

5 enum supported values:

UNDEFINEDEVENTWORKING_HOURSTIME_AVAILABILITYAVAILABILITY

Session type.

calendarConferenceobject

A conference created for the session according to the details set in the schedule's conference provider information. If the session is a recurring session, this field is inherited from the schedule. Partially deprecated. Only hostUrl and guestUrl are to be supported.

recurrencestring

A string representing a recurrence rule (RRULE) for a recurring session, as defined in iCalendar RFC 5545. If the session is an instance of a recurrence pattern, the instanceOfRecurrence property will be contain the recurrence rule and this property will be empty. The RRULE defines a rule for repeating a session. Supported parameters are:

Keyword	Description	Supported values
FREQ	The frequency at which the session is recurs. Required.	WEEKLY
INTERVAL	How often, in terms of FREQ, the session recurs. Default is 1. Optional.
UNTIL	The UTC end date and time of the recurrence. Optional.
BYDAY	Day of the week when the event should recur. Required.	One of: MO, TU, WE, TH, FR, SA, SU

For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM: "FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"

instanceOfRecurrencestringRead-only

A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern. Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and recurrence is not empty.

versionobject

The session version. Composed by the schedule, session and participants versions.

Was this helpful?

Yes

PostQuery Sessions

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of sessions, given the provided time range, filtering, and paging.

To query for event instances within a specified time range of up to 1 year, provide a startDate and endDate.

Query Sessions runs with these defaults, which you can override:

Only sessions of type EVENT are returned. An event is a single or recurring session that appears in a calendar, for example an appointment or a class.
instances is true. This means only single session instances and instances of recurring sessions are returned.
includeExternal is false. This means that sessions imported from connected external calendars are not returned.
Session objects are returned with the fields specified in the NO_PI fieldset. This means they don't contain personal information.
query.cursorPaging.limit is 100.

Note the following limitations, which you can't override:

Sessions are always sorted by start.timestamp in ASC order.
The maximum time range you can query for session instances is 1 year. If you are querying for recurring session definitions, rather than session instances, this limit doesn't apply.
Pagination is not supported for recurring session definition queries.

To query only for working hours sessions, set type to WORKING_HOURS. A working hours session is a single or recurring session that defines availability in a schedule.

To query for all session types, including events and working hours sessions, set type to ALL.

To query for recurring session pattern definitions, set instances to false. In this case, fromDate and toDate may be more than 1 year apart.

To return session objects including personal information, use the ALL_PI fieldset. This requires the Read Bookings Calendar - Including Participants or the Manage Bookings Services and Settings or the Manage Business Calendar permission scope.

For details on fieldsets, see Sessions: Supported Fieldsets.

For field support for filters, see Sessions: Supported Filters.

To learn about working with Query endpoints in general, see API Query Language and Field Projection.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

POST

https://www.wixapis.com/bookings/v2/calendar/sessions/query

Was this helpful?

Yes