Skip to main content
GET
/
companies
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 companyListResponse of client.companies.list()) {
  console.log(companyListResponse.id);
}
{
  "data": [
    {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "Pickaxe",
      "description": "Learn the fundamentals of data analytics with hands-on projects.",
      "verified": true,
      "send_customer_emails": true,
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "member_count": 42,
      "owner_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "route": "pickaxe",
      "logo": {
        "url": "https://media.whop.com/abc123/optimized.jpg"
      },
      "published_reviews_count": 42,
      "metadata": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

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

​
parent_company_id
string | null

The unique identifier of the parent platform company. When provided, lists connected accounts under that platform. Omit to list the current user's own companies.

​
direction
enum<string> | null

The sort direction for results. Defaults to descending.

Available options:
asc,
desc
​
created_before
string<date-time> | null

Only return companies created before this timestamp.

Example:

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

​
created_after
string<date-time> | null

Only return companies created after this timestamp.

Example:

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

Response

A successful response

The connection type for PublicCompany.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.