List Clerk waitlist entries

List waitlist entries in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/waitlist-entries

https://api.vee3.io/v1/clerk/waitlist-entries

5 tokens

List waitlist entries in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.list_waitlist_entries

Parameters6 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

limitintegerOptional

Maximum number of waitlist entries to return (1–500).

Default: 10

offsetintegerOptional

Number of waitlist entries to skip before returning results.

Default: 0

querystringOptional

Filter by email address or waitlist entry id.

statusstringOptional

Optional status filter: "pending", "invited", "rejected", or "completed".

order_bystringOptional

Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at.

Response8 fields

waitlist_entriesarrayitems

6 fields

Waitlist entries returned for the requested page.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

total_countinteger

Total number of waitlist entries on this page.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/waitlist-entries"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200First page of waitlist entries.

waitlist_page.json

{
  "waitlist_entries": [
    {
      "id": "wle_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "is_locked": false
    }
  ],
  "total_count": 1
}