This method has been replaced with Query Events, and will be removed on June 30, 2025.
Retrieves a list of sessions, given the provided time range, filtering, and paging.
Deprecation Notice:
This endpoint has been replaced with Calendar V3 Query Events and External Calendar V2 List Events and will be removed on June 30, 2025.
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:
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.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:
start.timestamp
in ASC
order.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.
Start of the time range for which sessions are returned, in ISO 8601 format.
Sessions that begin before the fromDate
but end after it are included in the results. For recurring session definitions, this means the start
value is before the fromDate
and the UNTIL
value in the recurrence
property is after the fromDate
.
Required, unless query.cursorPaging
is provided.
End of the time range for which sessions are returned, in ISO 8601 format.
Sessions that begin before the toDate
but end after it are included in the results. For recurring session definitions, this means the start
value is before the toDate
and the UNTIL
value in the recurrence
property is after the toDate
.
Required, unless query.cursorPaging
is provided.
Max: 1 year after fromDate
for session instance queries. This limit doesn't apply to recurring session definition queries.
Query options.
Type of sessions to return.
EVENT
: Returns only sessions of type EVENT
.WORKING_HOURS
: Returns only sessions of type WORKING_HOURS
.ALL
: Returns sessions of all types.Default: EVENT
.
Whether to return only single session instances and instances of recurring sessions.
If true
, only single session instances and instances of recurring sessions are returned.
If false
, only recurring session definitions are returned. Note: Cursor pagination is not supported for recurring session definition queries.
Default: true
.
Whether to include sessions imported from connected external calendars in the results.
Default: false
.
List of sessions matching the query.
Paging metadata.
curl -X POST 'https://www.wixapis.com/bookings/v2/calendar/sessions/query' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"fromDate": "2022-12-25T00:00:00Z",
"toDate": "2022-12-31T00:00:00Z",
"instances": true
}'
{
"sessions": [
{
"id": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1Hdp0Ird6iyxZHRVdpbgnFQ1A8TFAqwlb99bRYhgPbdrsM2KdA4n8FTg8WSwi5SBXcLVvpJKmHIqcD34lFwvaZDMhHc1Qoa3MnL6EbXON6JusUwKE9aZDI3PqT1WZcPMPsQuzOgSsBUy8NRZcLzDhHZ57ZCR6WOBBKEXepun53wXZ10birRy12YgkpdMjZ7baghNVRN8vmLDnkZccaQiMvpcNeey0u0FwXoNIszi00YKGp21ZFV6Bcd2w3D3hhO5e0ENvMnZ41t",
"scheduleId": "44de147c-5405-4601-8491-de514d815bf2",
"scheduleOwnerId": "9fe3d2d6-bbb4-46bf-805d-5cc276c12e73",
"start": {
"timestamp": "2022-12-18T09:30:00Z",
"localDateTime": {
"year": 2022,
"monthOfYear": 12,
"dayOfMonth": 18,
"hourOfDay": 11,
"minutesOfHour": 30
},
"timeZone": "Asia/Jerusalem"
},
"end": {
"timestamp": "2022-12-18T11:00:00Z",
"localDateTime": {
"year": 2022,
"monthOfYear": 12,
"dayOfMonth": 18,
"hourOfDay": 13,
"minutesOfHour": 0
},
"timeZone": "Asia/Jerusalem"
},
"affectedSchedules": [
{
"scheduleId": "8f78fe42-f522-44d6-acce-38a0b0c47dc9",
"transparency": "BUSY",
"scheduleOwnerId": "196a406f-f54b-4602-8f41-0a4be7562f1d",
"scheduleOwnerName": "MICHAEL"
}
],
"title": "The 7 Kings",
"tags": ["GROUP"],
"location": {
"locationType": "OWNER_BUSINESS",
"businessLocation": {
"id": "5a5b25b0-4005-4f92-b2cb-802448ecd6c1",
"name": "Tel Aviv-Yafo",
"default": false,
"status": "ACTIVE",
"locationType": "UNKNOWN",
"timeZone": "Europe/Dublin",
"phone": "",
"revision": "2",
"archived": false
}
},
"capacity": 50,
"remainingCapacity": 50,
"rate": {
"labeledPriceOptions": {
"general": {
"amount": "5",
"currency": "EUR",
"downPayAmount": "0"
}
}
},
"notes": "",
"totalNumberOfParticipants": 0,
"participants": [],
"inheritedFields": [
"affectedSchedules",
"calendarConference",
"capacity",
"end",
"externalCalendarOverrides",
"location",
"rate",
"start",
"tags",
"title"
],
"status": "CONFIRMED",
"recurringSessionId": "44de147c540546018491de514d815bf2-177e5b08160149eba112ea7b698b4a82",
"type": "EVENT",
"instanceOfRecurrence": "FREQ=WEEKLY;INTERVAL=1;BYDAY=SU",
"version": {
"scheduleVersion": 21,
"sessionVersion": 0,
"participantsVersion": 0
}
},
{
"id": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1Hv8vR80J28PRbGViGmpjKzJyheWVgfa6t5bWNQIgUMccjenHiovFUcmT74dMuPhczZ2Udi26JNVesJlGWqWFuB5NxtZamktCmoOluLcopBYGxjlGF7RBpgljNouOMCNHrWMWWI9gg4MjgzCQAoCk5rSUUlxfjBpL9ssatQ3GWgAQsw9MMRchYhRqPb7D5oPg1Y6cG8DqgxkOqseLKEft5EqG82lmNZ0nwIjF2ubpl0O1XZjcoIS4bL8uFIvgehtjtQymMDKBaf",
"scheduleId": "58aabcad-45bf-4270-ac89-2ee77e674c0a",
"scheduleOwnerId": "8b0e1e3c-9923-4a60-acb3-f2f83188fbd7",
"start": {
"timestamp": "2022-12-18T11:00:00Z",
"localDateTime": {
"year": 2022,
"monthOfYear": 12,
"dayOfMonth": 18,
"hourOfDay": 13,
"minutesOfHour": 0
},
"timeZone": "Asia/Jerusalem"
},
"end": {
"timestamp": "2022-12-18T12:30:00Z",
"localDateTime": {
"year": 2022,
"monthOfYear": 12,
"dayOfMonth": 18,
"hourOfDay": 14,
"minutesOfHour": 30
},
"timeZone": "Asia/Jerusalem"
},
"affectedSchedules": [
{
"scheduleId": "c7831755-b08c-48bb-925a-43515c8c28df",
"transparency": "BUSY",
"scheduleOwnerId": "e5d9dedc-dc5e-4900-a327-78b61de92241",
"scheduleOwnerName": "VERONICA"
}
],
"title": "The City of David",
"tags": ["GROUP"],
"location": {
"locationType": "OWNER_BUSINESS",
"businessLocation": {
"id": "5a5b25b0-4005-4f92-b2cb-802448ecd6c1",
"name": "Tel Aviv-Yafo",
"default": false,
"status": "ACTIVE",
"locationType": "UNKNOWN",
"timeZone": "Europe/Dublin",
"phone": "",
"revision": "2",
"archived": false
}
},
"capacity": 50,
"remainingCapacity": 50,
"rate": {
"labeledPriceOptions": {
"general": {
"amount": "5",
"currency": "EUR",
"downPayAmount": "0"
}
}
},
"notes": "",
"totalNumberOfParticipants": 0,
"participants": [],
"inheritedFields": [
"affectedSchedules",
"calendarConference",
"capacity",
"end",
"externalCalendarOverrides",
"location",
"rate",
"start",
"tags",
"title"
],
"status": "CONFIRMED",
"recurringSessionId": "58aabcad45bf4270ac892ee77e674c0a-c24f616b27504634bee10eec8911c4a1",
"type": "EVENT",
"instanceOfRecurrence": "FREQ=WEEKLY;INTERVAL=1;BYDAY=SU",
"version": {
"scheduleVersion": 31,
"sessionVersion": 0,
"participantsVersion": 0
}
}
],
"pagingMetadata": {
"cursors": {
"next": "JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiSF9ObGwwREwifQ.CUeKdaL6qLh6PF39HOJjrgoqG4wir-mGn6vViopOmLQ3UBEDnvVrvg.HDryXRLGgcnaQ3o6dmquQA.9klvmBOHxQBJfgKV3_PwoGVp3F7wkJj8mdKGRQcJcvI5-RxQ7_ndQMbJHVtEqqRVKA7y9_WflN3YFp5CReCTLWDdFqB4hp7GcxcC5cFAc_nk8Z6OAs_VirjL7RMd2dWfDuADVXcqbFqBjNNXXiG1GXzPptNnsUj5JpgmMgMQO9idSjDnO8cQ4uvHvs-jNsGc2YO9rfNOEECoi5T8EdEtLadgnf1qDrlINbwMtV-fhiERztGyE3cS51TRKPPF_YuqFWs3yZOjkFJiI1O2kAYB13X4Ylj_jeEN582lFL3W_5VEtFoy-u9wGQCe5qzMCrEIi6UbJu37U2xZIyLOCq6vntAlB0dk8tF7y6fMp8DrNWnpdaOyRL0D89dMoOux-YV02hGXMN5YBKlCCbxJeJSxhKkKF2I5o6PlMp7-YIWeJJTngeEHc9AfIYNZ0hk2hFo_WyEBC8hLwlI2oMHmHFVP2lyzYiXKHunXvTXFmfkD1N0wVpD-2F9Fhu0REnO78BxRmM1oCrYR5oSbNrifxcRcdu7Wl68hwfNbwwGBVFER9N64Atz-El9sRgNKxwekohZCAgC5zwhDBDmfEeQ19PA3yNO2WikJLrfZBrVVtjDEMdham-T9HwcAT1tbuY8Rw8gQQ0axyDZrzL-VDSfEbnu7-orqOimDT8tQCJiXrVqytn3czhe6MWp5PfsH45Mp77z9cylyqjDjbD1bvf-fvPQdJ9ORkA6sgOEXIbSEeA0SWirQrg47goBUIeg3VOEfKDr6EH3g-hmASiyhdp_wwZ7u7LMui0RbqkeXPt-hoqqevj7sJpOa5qluawWx4jH3eBO4JW6Pr3fswd5FCYx5aNthJ_FMqo_lPKw1_bqoICThB2SGloLM8187FHQ_pV5Va6RmrK1k4hAXU0OtElwNz-Gjh1bZTMcyxccH8sLmPyfRZ0LYDBlh-p_tOzBphGvLltEc3-CSs6MXonMmjuyykuumvqrcPgnN7BSklCPu3ESM4Nd9kSGqPLzbbwqYGyGXgYg7I4XaaSNMHspXdFj8ioZVgewJE161DUcIW-kA4jlKumziIk2OmF5OK6oGYJNEXWC_vjLPRe6NYKH_snYn2_IAnULYtoVHQhphuDoTjCQ3RiurtDX_rhLOOXwENSYjbAizITB0oYlG6GdNa38bo-UgOWLCDNw6cVA7PJ_DsIzDCdGLp7q2bXtGa0Diud9RLP7YMZFmUfueEwPqQbt0mdYjyzr5hVVoGNgkcnCBB8FejWvAiK6--ctQJ9T5YHrsNC03EYai4Vx-WGcQsVcDzGgYng.lTwrVvfll8UKJvAoSBrybg"
}
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.