API Reference

Get wait list settings

This API used to get wait list settings associated with the specified event.
This API can be access by event admin and super admin. It will return wait list details like manualReleaseTickets, remainingTickets, timeToRespondInHours, waitListEnabled, waitListTicketReleaseMessage and many more.
To call this API, user have to pass path and query param with API URL like eventurl, recurringEventId and authentication key to authenticate user.

Here is the description of response attributes, which returns to the form of JSON.

AttributesDescription
manualReleaseTicketsEnabling this field will require you to manually release tickets from waitlist.
maxWaitListSizeThis field will return number of tickets allowed for waiting, pass 0 for unlimited tickets.
maxWaitListSizeReachedThis field returns boolean value of whether maximum size reached for waitlist.
phoneNumberRequiredThis field returns boolean value of whether phone number required.
remainingTicketsThis field returns number of remaining ticket for waitlist.
timeToRespondInDaysThis field returns time to respond for a user in days.
timeToRespondInHoursThis field returns time to respond for a user in hours.
timeToRespondInMinutesThis field returns time to respond for a user in minutes.
waitListEnabledThis field returns boolean value of whether waitlist is enabled.
waitListTicketReleaseMessageThis field returns message to send when tickets become available.
waitListTriggerThis field returns on which trigger waitlist should be enabled.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
200Successfully retrieved wait list settings
401You are not authorized to view the resource
403Accessing the resource you were trying to reach is forbidden
404The resource you were trying to reach is not found
4030201Not Event Host
Language
Credentials
Header
Click Try It! to start a request and see the response here!