List 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({ parent_company_id: 'parent_company_id' })) {
  console.log(companyListResponse.id);
}

{
  "data": [
    {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "<string>",
      "description": "<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,
      "owner_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "route": "<string>",
      "logo": {
        "url": "<string>"
      },
      "published_reviews_count": 42,
      "metadata": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

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({ parent_company_id: 'parent_company_id' })) {
  console.log(companyListResponse.id);
}

{
  "data": [
    {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "<string>",
      "description": "<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,
      "owner_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "route": "<string>",
      "logo": {
        "url": "<string>"
      },
      "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

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

parent_company_id

string

required

The ID of the parent company to list connected accounts for

direction

enum<string> | null

The direction to sort the companies by

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 PublicCompany.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

data.title

string

required

The title of the company.

data.description

string | null

required

The creator pitch for the company.

data.verified

boolean

required

If the company is Whop Verified

data.business_type

enum<string> | null

required

The type of business the company is.

Available options:

education_program,

coaching,

software,

paid_group,

newsletter,

agency,

physical_products,

brick_and_mortar,

events,

coaching_and_courses,

other,

saas,

course,

community

data.industry_type

enum<string> | null

required

The specific industry the company operates in.

Available options:

trading,

sports_betting,

reselling,

fitness,

amazon_fba,

real_estate,

kindle_book_publishing,

dating,

agencies,

health_and_wellness,

social_media,

sales,

business,

ecommerce,

video_games,

home_services,

ai,

public_speaking,

personal_finance,

careers,

travel,

clipping,

spirituality,

vas,

personal_development,

software,

other,

marketing_agency,

sales_agency,

ai_agency,

design_agency,

coaching_agency,

development_agency,

recruiting_agency,

customer_support_agency,

clipping_agency,

clothing,

supplements,

beauty_and_personal_care,

fitness_gear,

accessories,

home_goods,

electronics_and_gadgets,

food_and_beverages,

gym,

restaurant,

retail_store,

coffee_shop,

salon_spa,

medical_dentist_office,

hotel_lodging,

auto_repair_shop,

masterminds,

webinars,

bootcamps,

convention,

concerts,

meetups,

parties

data.created_at

string<date-time>

required

When the company was created (signed up)

Example:

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

data.updated_at

string<date-time>

required

The time the company was last updated.

Example:

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

data.member_count

integer

required

The number of members in the company.

Example:

42

data.owner_user

object

required

The user who owns this company

Show child attributes

data.owner_user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.owner_user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.owner_user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.route

string

required

The slug/route of the company on the Whop site.

data.logo

object

required

The company's logo.

Show child attributes

data.logo.url

string | null

required

This is the URL you use to render optimized attachments on the client. This should be used for apps.

data.published_reviews_count

integer

required

The number of reviews that have been published for the company.

Example:

42

data.metadata

object

required

A key-value store of data for the account, created/updated by the platform that made the account.

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?

Check access Create company

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response