Skip to main content

list()

Gets a list of waitlist entries for the instance. By default, the list is returned in descending order by creation date (newest first).

Returns a PaginatedResourceResponse object with a data property containing an array of WaitlistEntry objects and a totalCount property containing the total number of waitlist entries for the instance.

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

WaitlistEntryListParams

  • Name
    limit?
    Type
    number
    Description

    Maximum number of items returned per request. 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 items when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.

  • Name
    orderBy?
    Type
    WithSign<"created_at" | "invited_at" | "email_address">
    Description

    Filters waitlist entries in a particular order. Prefix a value with + to sort in ascending order, or - to sort in descending order. Defaults to -created_at.

  • Name
    query?
    Type
    string
    Description

    Filters waitlist entries by email_address or id.

  • Name
    status?
    Type
    "pending" | "invited" | "completed" | "rejected"
    Description

    Filters waitlist entries by status.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

Filter by email address

Gets a list of waitlist entries for a given email address.

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

Filter by status

Gets a list of waitlist entries that have not yet been accepted.

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

Gets a list of waitlist entries, limited to the specified number of results.

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

Skip results

Gets a list of waitlist entries, skipping the specified number of results.

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.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub