SupDesk
GET/v1/waitlist/signups

List waitlist signups

Lists waitlist signups, optionally filtered by status or searched by email. Use limit and offset to control the result page; limit defaults to 20 and offset defaults to 0. The response includes pagination metadata indicating whether more results are available.

4 parameters
limitintegeroptional
Maximum number of signups to return, from 1 to 100. Defaults to 20 when omitted.
Default:20
offsetintegeroptional
Number of signups to skip. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
statusstringoptional
Filter signups by status: `waiting`, `invited`, or `joined`.
Allowed:waitinginvitedjoined
searchstringoptional
Search signups by email address.

2 status codes
200Returns a page of waitlist signup objects in `data` and pagination metadata, including the limit, offset, and whether more results are available.
dataarray<object>optional
paginationobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. limit must be between 1 and 100, offset must be 0 or greater, and status must be waiting, invited, or joined.