Clerk docs

Waitlist Entries

List all waitlist entries

Retrieve a list of waitlist entries for the instance. Entries are ordered by creation date in descending order by default. Supports filtering by email address or status and pagination with limit and offset parameters.

SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offset
number >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

query
string

Filter waitlist entries by email address

status
string

Filter waitlist entries by their status

Enum: "pending" "invited" "completed" "rejected"
order_by
string
Default: "-created_at"

Specify the order of results. Supported values are:

  • created_at
  • email_address
  • invited_at

Use + for ascending or - for descending order. Defaults to -created_at.

Responses
200

List of waitlist entries

get/waitlist_entries
Response samples
application/json
{
  • "data": [
    ],
  • "total_count": 0
}

Create a waitlist entry

Creates a new waitlist entry for the given email address. If the email address is already on the waitlist, no new entry will be created and the existing waitlist entry will be returned.

SecuritybearerAuth
Request
Request Body schema: application/json
email_address
required
string

The email address to add to the waitlist

notify
boolean

Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true.

Responses
200

A Waitlist Entry

400

Request was not successful

422

Invalid request parameters

post/waitlist_entries
Request samples
application/json
{
  • "email_address": "string",
  • "notify": true
}
Response samples
application/json
{
  • "object": "waitlist_entry",
  • "id": "string",
  • "email_address": "user@example.com",
  • "status": "pending",
  • "created_at": 0,
  • "updated_at": 0,
  • "invitation": {
    }
}