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.

get/waitlist_entries

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/waitlist_entries
  • Auth: HTTP bearer

Query parameters

limitinteger

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

offsetinteger

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

querystring

Filter waitlist entries by email_address or id

status'pending' | 'invited' | 'completed' | 'rejected'

Filter waitlist entries by their status

order_bystring

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.

Response

List of waitlist entries

total_countinteger required

Total number of waitlist entries

Example response

{
  "data": [
    {
      "status": "pending",
      "invitation": {
        "status": "pending"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 49 revisions of this API.