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

List Sessions

Developer Preview

Returns multiple sessions from the calendar.

Permissions
This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope With the Read Bookings Calendar permission scope, the sessions return without participants.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

POST

https://www.wixapis.com/bookings/v1/calendar/sessions/list

Body Params

NAME
TYPE
DESCRIPTION
ids
Required

Array<string>

Session ID.

fieldMask

object

Field mask of fields to return. Currently only supports the "scheduleOwnerId" field.

Response Object

NAME
TYPE
DESCRIPTION
sessions

Array<object>

Session.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

List Sessions with field mask.

Currently, only the 'scheduleOwnerId' field is supported.

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/bookings/v1/calendar/sessions/list' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "ids": [
7 "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvKBjRGhub7Y7cLdIExqh2iuWTcm8Ezhcej4vS7gdabMeRHIZtLf1Xq1o1EdwQ2v2gCUSuDqwUIfj0DFyUGWNBThpxqEHVWLKC6by49GVZaOmlNMHsJ00NTDf7VyZ0jyciRDw3Kg7xXXHCpWbZZSAJCvLBYKSd3VlgRJsiC8NjVEf8UBTqOZ3b9nw5yDe9z2JL6ObtlWSYl8K5rgKZXBCKKIo1jxCKTreB2dgEguqri8kgTOdBsGxNX5ijCmYSkoaLJYsV5onmWez",
8 "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvKBjRGhub7Y7cLdIExqh2iuWTcm8Ezhcej4vS7gdabMeRHIZtLf1Xq1o1EdwQ2v2gCUSuDqwUIfj0DFyUGWSZgwl3gKqmjCZUtIAmyo4jDXnAxu7AS66pLAF4I6gBn3NCkme1G5UQdXXiOtyZu4h8hgfop8a5Wko4cbtvEML1HRYIzUlpAKLN1DYVrsyhoeUV2vofC9vLednHRD72bJVs5XUmuhs7I7DmkeDPiDZmCtye5UJx9Usm1u8eT3npvjsXFOuKHdGx27x"
9 ],
10 "fieldMask": {
11 "paths": [
12 "scheduleOwnerId"
13 ]
14 }
15 }'

Response

json

1
2{"sessions": [
3 {
4 "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvKBjRGhub7Y7cLdIExqh2iuWTcm8Ezhcej4vS7gdabMeRHIZtLf1Xq1o1EdwQ2v2gCUSuDqwUIfj0DFyUGWNBThpxqEHVWLKC6by49GVZaOmlNMHsJ00NTDf7VyZ0jyciRDw3Kg7xXXHCpWbZZSAJCvLBYKSd3VlgRJsiC8NjVEf8UBTqOZ3b9nw5yDe9z2JL6ObtlWSYl8K5rgKZXBCKKIo1jxCKTreB2dgEguqri8kgTOdBsGxNX5ijCmYSkoaLJYsV5onmWez",
5 "scheduleId": "",
6 "scheduleOwnerId": "e6b6108c-92bc-462b-937c-dab386909fd2",
7 "affectedSchedules": [],
8 "tags": [],
9 "notes": "",
10 "totalNumberOfParticipants": 0,
11 "participants": [],
12 "inheritedFields": [],
13 "status": "UNDEFINED",
14 "type": "UNDEFINED"
15 },
16 {
17 "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvKBjRGhub7Y7cLdIExqh2iuWTcm8Ezhcej4vS7gdabMeRHIZtLf1Xq1o1EdwQ2v2gCUSuDqwUIfj0DFyUGWSZgwl3gKqmjCZUtIAmyo4jDXnAxu7AS66pLAF4I6gBn3NCkme1G5UQdXXiOtyZu4h8hgfop8a5Wko4cbtvEML1HRYIzUlpAKLN1DYVrsyhoeUV2vofC9vLednHRD72bJVs5XUmuhs7I7DmkeDPiDZmCtye5UJx9Usm1u8eT3npvjsXFOuKHdGx27x",
18 "scheduleId": "",
19 "scheduleOwnerId": "e6b6108c-92bc-462b-937c-dab386909fd2",
20 "affectedSchedules": [],
21 "tags": [],
22 "notes": "",
23 "totalNumberOfParticipants": 0,
24 "participants": [],
25 "inheritedFields": [],
26 "status": "UNDEFINED",
27 "type": "UNDEFINED"
28 }
29]}
List Sessions