Skip to main content
GET
/
entries
JavaScript
import Whopsdk from 'whopsdk';

const client = new Whopsdk({
  apiKey: 'My API Key',
});

// 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",
        "username": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "created_at": 1701406800
    }
  ],
  "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 The direction of the sort.

Available options:
asc,
desc
​
order
enum<string> | null

The order to sort the entries by Which columns can be used to sort.

Available options:
id,
created_at
​
product_ids
string[] | null

The access pass 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

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.

​
statuses
(enum<string> | null)[] | null

The statuses to filter the entries by

Response

A successful response

The connection type for PublicEntry.

​
data
array | null
required

A list of nodes.

​
page_info
object | null
required

Information to aid in pagination. Information about pagination in a connection.

⌘I