List all waitlist entries | Clerk API (unofficial showcase)

5 parameters

limitintegeroptional

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

Default:10

offsetintegeroptional

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

Default:0

querystringoptional

Filter waitlist entries by `email_address` or `id`

statusstringoptional

Filter waitlist entries by their status

Allowed:pendinginvitedcompletedrejected

order_bystringoptional

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`.

Default:-created_at

1 status code

200List of waitlist entries

dataarray<object>required

total_countintegerrequired

Total number of waitlist entries

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.waitlistEntries.list({
  limit: 20,
  offset: 0,
  query: "keyword",
  status: "example",
  orderBy: "example",
});

{
  "data": [
    {
      "object": "waitlist_entry",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email_address": "user@example.com",
      "status": "pending",
      "is_locked": true,
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z",
      "invitation": {
        "object": "invitation",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email_address": "user@example.com",
        "revoked": false,
        "status": "pending",
        "url": "https://example.com",
        "expires_at": 1,
        "created_at": 1,
        "updated_at": "2026-01-15T09:00:00Z"
      }
    }
  ],
  "total_count": 42
}

Request

Response