List entries

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const entryListResponse of client.entries.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(entryListResponse.id);
}

{
  "data": [
    {
      "id": "entry_xxxxxxxxxxxx",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "<string>"
      },
      "status": "drafted",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "[email protected]"
      },
      "created_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

entries

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const entryListResponse of client.entries.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(entryListResponse.id);
}

{
  "data": [
    {
      "id": "entry_xxxxxxxxxxxx",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "<string>"
      },
      "status": "drafted",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "[email protected]"
      },
      "created_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Query Parameters

after

string | null

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

before

string | null

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

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

company_id

string

required

The ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

direction

enum<string> | null

The direction to sort the entries by

Available options:

asc,

desc

order

enum<string> | null

The order to sort the entries by

Available options:

id,

created_at

product_ids

string[] | null

The product IDs to filter the entries by

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

plan_ids

string[] | null

The plan IDs to filter the entries by

statuses

enum<string>[] | null

The statuses to filter the entries by

The status of an entry to a waitlist.

Available options:

drafted,

pending,

approved,

denied,

any

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

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

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for PublicEntry.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The internal ID of the entry.

Example:

"entry_xxxxxxxxxxxx"

data.plan

object

required

The waitlist plan the entry if for.

Show child attributes

data.plan.id

string

required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

data.product

object

required

The product tied to this entry, if there is one.

Show child attributes

data.product.id

string

required

The internal ID of the public product.

Example:

"prod_xxxxxxxxxxxxx"

data.product.title

string

required

The title of the product. Use for Whop 4.0.

data.status

enum<string>

required

The status of the entry.

Available options:

drafted,

pending,

approved,

denied,

any

data.user

object

required

The user who created the entry.

Show child attributes

data.user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.user.email

string | null

required

The email of the user

Example:

"[email protected]"

data.created_at

string<date-time> | null

required

When the entry was created.

Example:

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

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Membership deactivated Retrieve entry

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response