|The frequency at which the session is recurs. Required.
|How often, in terms of FREQ, the session recurs. Default is 1. Optional.
|The UTC end date and time of the recurrence. Optional.
|Day of the week when the event should recur. Required.
|One of: MO, TU, WE, TH, FR, SA, SU
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
Query Sessions runs with these defaults, which you can override:
- Only sessions of type
EVENTare returned. An event is a single or recurring session that appears in a calendar, for example an appointment or a class.
instancesis true. This means only single session instances and instances of recurring sessions are returned.
includeExternalis false. This means that sessions imported from connected external calendars are not returned.
- Session objects are returned with the fields specified in the
NO_PIfieldset. This means they don't contain personal information.
Note the following limitations, which you can't override:
- Sessions are always sorted by
- 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
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
To query for recurring session pattern definitions, set
false. In this case,
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.