v9

OpenAPI 3.1.02026-08-043703845.2 MB

Entries

List entries

Returns a paginated list of waitlist entries for a company, with optional filtering by product, plan, status, and creation date.

Required permissions:

plan:waitlist:read
member:email:read

get/entries

Query parameters

afterstring nullable

Returns the elements in the list that come after the specified cursor.

beforestring nullable

Returns the elements in the list that come before the specified cursor.

firstinteger nullable

Returns the first n elements from the list.

Example:42

lastinteger nullable

Returns the last n elements from the list.

Example:42

company_idstring required

The unique identifier of the company to list waitlist entries for.

Example:biz_xxxxxxxxxxxxxx

direction'asc' | 'desc'

The direction of the sort.

order'id' | 'created_at'

Which columns can be used to sort.

product_idsstring[] nullable

Filter entries to only those for specific products.

plan_idsstring[] nullable

Filter entries to only those for specific plans.

statusesEntryStatus[] nullable

Filter entries by their current status.

created_beforestring date-time nullable

Only return entries created before this timestamp.

Example:2023-12-01T05:00:00.401Z

created_afterstring date-time nullable

Only return entries created after this timestamp.

Example:2023-12-01T05:00:00.401Z

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "entry_xxxxxxxxxxxx",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics"
      },
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ]
}