Skip to content

users_waitlist_list

List this product's waitlist entries, newest first.

Tool

users_waitlist_list

List this product's waitlist entries, newest first.

List this product's waitlist entries, newest first. Each row is a directory user in state `waitlisted` PLUS the feature-local funnel state: where the signup came from (referrer/UTM), the consent proof recorded for it, and its status. Filter by `status` to work one stage of the funnel, or by `confirmed: false` to find double-opt-in signups whose address never confirmed. Paginate with `cursor`.

Behavior

HTTP
POST /users/waitlist/list

Arguments

Name
Type
Required
Description
limit
integer
—
Entries per page, 1-100. Default 25.
cursor
string
—
Opaque cursor from the previous page's `nextCursor`. Omit for the first page.
status
string
—
Filter by funnel status: 'pending', 'invited', 'registered' or 'withdrawn'. Omit for all.
confirmed
boolean
—
Double opt-in only: false returns entries whose address never confirmed. Omit for both.

Response

Field
Type
Always
Description
entries
array
•
The page of waitlist entries, newest first.
nextCursor
string
•
Pass back as `cursor` to fetch the next page. Null when this page is the last.

Try it

List this product's waitlist entries, newest first.

When to use

List this product's waitlist entries, newest first. Each row is a directory user in state `waitlisted` PLUS the feature-local funnel state: where the signup came from (referrer/UTM), the consent proof recorded for it, and its status. Filter by `status` to work one stage of the funnel, or by `confirmed: false` to find double-opt-in signups whose address never confirmed. Paginate with `cursor`.

Example

Ask your agent something like this:

List this product's waitlist entries, newest first.

The agent will invoke users_waitlist_list with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select