IN THIS ARTICLE

About the Calendar API

The calendar service includes read-only endpoints that allow the retrieval of business-related events, in integration with Wix Bookings.

Deprecation Notice:

The List Sessions endpoint will be removed on June 30, 2023. Please use Query Sessions instead.

Terminology

  • Session: An occupied period of time on a schedule (e.g., if a “Vinyasa Yoga” service is offered every Monday betwen 6-7pm, the class on Monday June 7, 2020 from 6-7pm is one session on a schedule with a recurring session every Monday). A session of type EVENT is a recurring or single session that appears in a specific block of time in a calendar, such as an appointment or a class.

  • Schedule: A collection of sessions related to a specific entity (session, resource, etc.), with relevant metadata. The schedule entity represents information about when its owner can be booked for a service.

Important: The owner of the schedule can be a resource (e.g., a staff member or room) or a collection of sessions (e.g., a course with multiple sessions).

Was this helpful?
Yes
No