EventWaitingAttendees
Search EventWaitingAttendees
Search and list EventWaitingAttendee records with filtering, sorting, and pagination.
GET
Search EventWaitingAttendees
An EventWaitingAttendee records a customer on the waiting list for a calendar event that has reached its maximum capacity. When a spot opens up, waiting attendees can be promoted to full attendees.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the EventWaitingAttendee-List role.Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the business linked to this record.
integer
Filter by iD of the calendar event linked to this record.
string
Filter by display name of the linked calendar event (read-only).
integer
Filter by iD of the coworker linked to this record.
string
Filter by display name of the linked coworker full (read-only).
string
Filter by the full name value for this event waiting attendee.
string
Filter by the email value for this event waiting attendee.
Range Filters
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by FullName
Range filters
Response
200
EventWaitingAttendee[]
The list of EventWaitingAttendee records matching the query. See the Get one EventWaitingAttendee endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search EventWaitingAttendees