Skip to main content
GET
/
products
JavaScript
import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const productListItem of client.products.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(productListItem.id);
}
{
  "data": [
    {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "<string>",
      "visibility": "visible",
      "headline": "<string>",
      "verified": true,
      "business_type": "education_program",
      "industry_type": "trading",
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "member_count": 42,
      "route": "<string>",
      "published_reviews_count": 42,
      "external_identifier": "<string>"
    }
  ],
  "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 to filter products by

Example:

"biz_xxxxxxxxxxxxxx"

​
product_types
enum<string>[] | null

The type of products to filter by

The different types an product can be. Only use 'regular'. The rest are for internal use

Available options:
regular,
app,
experience_upsell,
api_only
​
visibilities
enum<string>[] | null

The visibility of the products to filter by

The different levels of visibility for resources

Available options:
visible,
hidden,
archived,
quick_link,
all,
not_quick_link,
not_archived
​
order
enum<string> | null

The order of the products

Available options:
active_memberships_count,
created_at,
usd_gmv,
usd_gmv_30_days
​
direction
enum<string> | null

The direction of the order

Available options:
asc,
desc
​
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 PublicAccessPass.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.