Search...
Generate a test token to explore our APIs
List Waitlisted Entities
Developer Preview
Returns a list of waitlisted entries. Each WaitingListEntry returned holds the current Waitlist registrations, configuration and suggesting status.
Permissions
This endpoint requires the Read Bookings - Public Data permissions scope
Syntax
function ListWaitlisted Entities 1(waitingResources: array<string>): List<_com_wix_bookings_api_v1_ListWaitingListResponse>
List Waitlisted Entities Parameters
NAME
TYPE
DESCRIPTION
waitingResources
Required
Array<string>
List of sessions (waitingResources) with active waitlists.
Returns
Return Type:
object
NAME
TYPE
DESCRIPTION
list
Array<object>
Was this helpful?
List waitlist
Returns the wait list of the waiting resource.
Request
curl
Copy Code
1curl --X GET /2 'https://www.wixapis.com/bookings/v1/waitlist/list?waitingResources=193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F' \3 -H 'Authorization: <AUTH>'
Response
json
12{"list": [{3 "waitingResource": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F",4 "registrations": [5 {6 "id": "4f59e278-2fef-465c-a0d3-6f5c36b58667",7 "bookingId": "b1ebcbf5-ca5b-47aa-8c4e-739becf3c0cc",8 "waitingResource": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F",9 "availableActions": {10 "leave": true,11 "enroll": true12 },13 "status": "SUGGESTING"14 },15 {16 "id": "2724acf6-fedd-402b-8cbc-48bc784481d9",17 "bookingId": "a4b4ad07-2c58-451e-a79d-4d59d31f8cc2",18 "waitingResource": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F",19 "availableActions": {20 "leave": true,21 "enroll": true22 },23 "status": "WAITING"24 }25 ],26 "numberOfRegistrations": 2,27 "capacity": 10,28 "timeWindowMinutes": 5,29 "status": "SUGGESTING"30}]}