`list()`

WaitlistEntryListParams
Examples
Backend API (BAPI) endpoint

Retrieves a list of waitlist entries. Returns a PaginatedResourceResponse object with a data property that contains an array of WaitlistEntry objects, and a totalCount property that indicates the total number of waitlist entries for the application.

function list(): (
  params: WaitlistEntryListParams,
) => Promise<PaginatedResourceResponse<WaitlistEntry[]>>

`WaitlistEntryListParams`

Name
limit?
Type
number
Description
The number of results to return. Must be an integer greater than zero and less than 501. Can be used for paginating the results together with offset. Defaults to 10.
Name
offset?
Type
number
Description
Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.
Name
query?
Type
string
Description
Filter waitlist entries by email_address or id.
Name
status?
Type
'pending' | 'invited' | 'completed' | 'rejected'
Description
Filter waitlist entries by their status.
Name
orderBy?
Type
'created_at' | 'updated_at' | 'email_address'
Description
Return waitlist entries in a particular order. Prefix with a - to reverse the order. Prefix with a + to list in ascending order. Defaults to '-created_at'.

Examples

Note

Using clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

Filter by email address

Retrieves a list of a wailist entries that is filtered by their email address using the query parameter.

const response = await clerkClient.waitlistEntries.list({
  // returns a list of waitlist entries for a given email address
  query: 'user1@example.com',
})

Filter by status

Retrieves a list of a wailist entries that is filtered by their status.

const { data, totalCount } = await clerkClient.waitlistEntries.list({
  // returns a list of waitlist entries that have not yet been accepted
  status: 'pending',
})

Limit the number of results

Retrieves a list of a waitlist entries that is filtered by the number of results.

const { data, totalCount } = await clerkClient.waitlistEntries.list({
  // returns the first 10 waitlist entries
  limit: 10,
})

Skip results

Retrieves a list of a waitlist entries that is filtered by the number of results to skip.

const { data, totalCount } = await clerkClient.waitlistEntries.list({
  // skips the first 10 waitlist entries
  offset: 10,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/waitlist_entries. See the BAPI reference for more information.

Last updated on Feb 16, 2026

Edit on GitHub

list()

WaitlistEntryListParams