Search.../
  1. REST
Generate a test token to explore our APIs

List Slots

DEPRECATED
Developer Preview

Deprecation Notice:

This endpoint has been deprecated and will be removed on Aug 31, 2023.
Please use Query Availability instead.

Returns the schedule slots, calculated according to the schedule's availability configuration.

The query object supports:

FIELDSupported FiltersDescription
from.eqQuery range start time. Required.
to.eqQuery range end time. Required.
scheduleIds.eqList of scheduleIds. Required. Up to 100 values are allowed.
location.locationType.eqFilter by session.location.location_type. Supported values: OWNER_BUSINESS, OWNER_CUSTOM and CUSTOM. Not supported for recurring sessions.
isAvailable.eqSlots with full no availability are returned by default. Filter.isAvailable = false is not supported.
location.businessLocation.id.eqFilter by session.location.business_location.id. Supports multiple values.
sortNot SupportedSorted by start.timestamp only.
fieldsSupported
pagingSupportedUse cursorPaging tokens.
For example, "cursorPaging" : { "limit": 2}.
The response includes nextPageToken field. Pass this value in the pageToken field in the following query,leaving the query field empty.
fieldsetsNot supported
  • The following objects in the listQuery parameter are not supported for this query:
    • sort
    • fieldsets
  • The businessLocation.businessSchedule object in the location object is not supported.

Permissions
This endpoint requires the Read Bookings Calendar Availability, the Read Bookings Calendar, the Read Bookings - Public Data, the Read Bookings - Including Participants or the Manage Bookings permission scope.

Syntax

function ListSlots(query: _com_wix_bookings_upstream_wix_common_Query, pageToken: string, listQuery: _com_wix_bookings_upstream_wix_common_QueryV2): ListSlots<_com_wix_bookings_calendar_api_v1_ListSlotsResponse>

List Slots Parameters

NAME
TYPE
DESCRIPTION
query
Deprecated
object
pageToken
Deprecated
string

Token for the next page of results.

listQuery
object

Filter and paging options.

Returns

Return Type:

object
NAME
TYPE
DESCRIPTION
slots
Array<object>

Slots on the calendar.

nextPageToken
Deprecated
string

Slots paging response. Token for the next page of results

pagingMetadata
object

Was this helpful?

List Slots

Lists all the slots of a specific schedule id at a specific date-time range.

Request

curl

Copy Code
1curl -L -X POST 'https://www.wixapis.com/bookings/v1/calendar/listSlots' \
2-H 'Authorization: <AUTH>' \
3-H 'Content-Type: application/json' \
4--data-raw '{
5  "listQuery": {
6    "filter": {
7      "from": "2020-01-07T07:00:00.000Z",
8      "to": "2021-11-14T07:59:59.999Z",
9      "scheduleIds": ["0e5fc5ad-3855-4c26-90f5-841bdec97fdd"]
10          }
11  }
12}'

Response

json

1{"slots": [
2    {
3    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKTa8lBiccGwf72nuwOzr7afn59msSEAO7DWk1hlbIBj9Fw4fqPTypFiqBvVJlmJDsUvNxwkEJnGdeOtwOZyonEsUXRYvUDV9mDHlUgwsjoXyuHrpxOXUyqvm2sMFIdc3KAKop7S70JFMq07SPZ4mf0tx0v2118WnQ5tHwDmLL5hVmHddSZNPVrfriP",
4    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
5    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
6    "start": {"timestamp": "2021-05-03T09:00:00Z"},
7    "end": {"timestamp": "2021-05-03T15:00:00Z"},
8    "affectedSchedules": [],
9    "tags": [],
10    "notes": "",
11    "totalNumberOfParticipants": 0,
12    "participants": [],
13    "inheritedFields": [],
14    "status": "UNDEFINED",
15    "type": "UNDEFINED"
16  },
17    {
18    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKLXvLdtmegzXgIQUtTj8014nlUI8Igv7Ick3Ymp9j8ysAikB2jNgl3SwTqS274JuvDrjBlcIzQ3pkBU5nJvBcxL7D4mbWBIAYgPbRlkrAOl5NR9NRP1jI5pGXGzwtsq3BaTAXgcPNSNeQe4R7Ltj76uvkK69ostIOenPBqnOBTtw8HaWii2t04v7fx",
19    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
20    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
21    "start": {"timestamp": "2021-05-05T09:00:00Z"},
22    "end": {"timestamp": "2021-05-05T15:00:00Z"},
23    "affectedSchedules": [],
24    "tags": [],
25    "notes": "",
26    "totalNumberOfParticipants": 0,
27    "participants": [],
28    "inheritedFields": [],
29    "status": "UNDEFINED",
30    "type": "UNDEFINED"
31  },
32    {
33    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKTa8lBiccGwf72nuwOzr7afn59msSEAO7DWk1hlbIBj9Fw4fqPTypFiqBvVJlmJDsUvNxwkEJnGdeOtwOZyopYQDt9HaLqK3OjIG016FJsIUtamSpvpOQHNdjdAak78sbUfOknizsIGMDO9ypDS4cWQHD8yHAl08PgdfWKMa6O9EdXMZzqaXpRKzAj",
34    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
35    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
36    "start": {"timestamp": "2021-05-10T09:00:00Z"},
37    "end": {"timestamp": "2021-05-10T15:00:00Z"},
38    "affectedSchedules": [],
39    "tags": [],
40    "notes": "",
41    "totalNumberOfParticipants": 0,
42    "participants": [],
43    "inheritedFields": [],
44    "status": "UNDEFINED",
45    "type": "UNDEFINED"
46  },
47    {
48    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKLXvLdtmegzXgIQUtTj8014nlUI8Igv7Ick3Ymp9j8ysAikB2jNgl3SwTqS274JuvDrjBlcIzQ3pkBU5nJvBfGyPkzkENQQO9FUhO1xPYiOddUnPnzlw3WJ2PMC6KNt8ET17U5VOvIbF34lta2hxAf0RP3Vc7E4GnGuoYBdp2xFYjnPp7t3BeKh0Dl",
49    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
50    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
51    "start": {"timestamp": "2021-05-12T09:00:00Z"},
52    "end": {"timestamp": "2021-05-12T15:00:00Z"},
53    "affectedSchedules": [],
54    "tags": [],
55    "notes": "",
56    "totalNumberOfParticipants": 0,
57    "participants": [],
58    "inheritedFields": [],
59    "status": "UNDEFINED",
60    "type": "UNDEFINED"
61  },
62    {
63    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKTa8lBiccGwf72nuwOzr7afn59msSEAO7DWk1hlbIBj9Fw4fqPTypFiqBvVJlmJDsUvNxwkEJnGdeOtwOZyqOnHsZfWdLjVfKsimUXkyBzPkPLMj6IuCMCkMUEHj3Y29VQxMKJdonfobfnp7tDbAe01AJdInsSLxzwoNZE0h1CgJFsEUK2Lj2I6sLV",
64    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
65    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
66    "start": {"timestamp": "2021-05-17T09:00:00Z"},
67    "end": {"timestamp": "2021-05-17T15:00:00Z"},
68    "affectedSchedules": [],
69    "tags": [],
70    "notes": "",
71    "totalNumberOfParticipants": 0,
72    "participants": [],
73    "inheritedFields": [],
74    "status": "UNDEFINED",
75    "type": "UNDEFINED"
76  },
77    {
78    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKLXvLdtmegzXgIQUtTj8014nlUI8Igv7Ick3Ymp9j8ysAikB2jNgl3SwTqS274JuvDrjBlcIzQ3pkBU5nJvDEVkTthOhMjKXYy6LLSeGBykd43LCMsFqGQBkhd5VY13fl89X3bgDRbuB2aF0YZWn0kE7J9VnBedS5v8nwerVHj4cqwxnAXK8qlezt7",
79    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
80    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
81    "start": {"timestamp": "2021-05-19T09:00:00Z"},
82    "end": {"timestamp": "2021-05-19T15:00:00Z"},
83    "affectedSchedules": [],
84    "tags": [],
85    "notes": "",
86    "totalNumberOfParticipants": 0,
87    "participants": [],
88    "inheritedFields": [],
89    "status": "UNDEFINED",
90    "type": "UNDEFINED"
91  },
92    {
93    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKLmeDmvakjhSJrceoRLrfnANqszZqkuE5hKuMTI2Nu2HPO3xiZSZ5xlzZGfV51BVZGj5UuUHCh2gDD1YMOvkpBBBEGijgbb9Kfd1DXnHqidNmGzM3SDWMgBOJf3ziAMFsQ3Ni6wZSukmHjpCQtDC8kUbsJO6XblCXylp4h1bnYFONNkNeUJSVp9iDV",
94    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
95    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
96    "start": {"timestamp": "2021-05-21T09:00:00Z"},
97    "end": {"timestamp": "2021-05-21T15:00:00Z"},
98    "affectedSchedules": [],
99    "tags": [],
100    "notes": "",
101    "totalNumberOfParticipants": 0,
102    "participants": [],
103    "inheritedFields": [],
104    "status": "UNDEFINED",
105    "type": "UNDEFINED"
106  },
107    {
108    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKTa8lBiccGwf72nuwOzr7afn59msSEAO7DWk1hlbIBj9Fw4fqPTypFiqBvVJlmJDsUvNxwkEJnGdeOtwOZyqR6paZltgCOMQP0yzthzeLSI2aCyHlP3VObk7tzG9OFMVB2LlGimnwRmspKKYGR58W9jSlyNuXWkI6wz4H8QhCdJvMCjqRfrng84rNt",
109    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
110    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
111    "start": {"timestamp": "2021-05-24T09:00:00Z"},
112    "end": {"timestamp": "2021-05-24T15:00:00Z"},
113    "affectedSchedules": [],
114    "tags": [],
115    "notes": "",
116    "totalNumberOfParticipants": 0,
117    "participants": [],
118    "inheritedFields": [],
119    "status": "UNDEFINED",
120    "type": "UNDEFINED"
121  },
122    {
123    "id": "4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvEWAFmz8wJXU5IeQA600NUh6802XIdsxWCxUrg9ZLvsJAbgihrApIfk6pc1YWMtamts3A0IaW0SnhZKltkKLXvLdtmegzXgIQUtTj8014nlUI8Igv7Ick3Ymp9j8ysAikB2jNgl3SwTqS274JuvDrjBlcIzQ3pkBU5nJvEnkWZO0OmN0CpX4SGP3FnFpyqJ3C39BsKsLWZGtopsQQgtWE7cOyvh8FpFxFDZXEwwBFox8N7kdHeH9wUDKFQ6Mhnj1jLcpI9iwK7yP",
124    "scheduleId": "0e5fc5ad-3855-4c26-90f5-841bdec97fdd",
125    "scheduleOwnerId": "2cd2b576-b57a-4e14-8440-12e991992028",
126    "start": {"timestamp": "2021-05-26T09:00:00Z"},
127    "end": {"timestamp": "2021-05-26T15:00:00Z"},
128    "affectedSchedules": [],
129    "tags": [],
130    "notes": "",
131    "totalNumberOfParticipants": 0,
132    "participants": [],
133    "inheritedFields": [],
134    "status": "UNDEFINED",
135    "type": "UNDEFINED"
136  }
137]}
List Slots with cursor-paging
List Slots by next-cursor