Skip to main content
GET
/
companies
/
{id}
JavaScript
import Whop from '@whop/sdk';

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

const company = await client.companies.retrieve('biz_xxxxxxxxxxxxxx');

console.log(company.id);
{
  "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": "<string>",
    "username": "<string>"
  },
  "route": "<string>",
  "logo": {
    "url": "<string>"
  },
  "published_reviews_count": 42,
  "metadata": {},
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "<string>",
      "website": "x"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID or route of the company

Example:

"biz_xxxxxxxxxxxxxx"

Response

A successful response

An object representing a (sanitized) company.

​
id
string
required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

​
title
string
required

The title of the company.

​
description
string | null
required

The creator pitch for the company.

​
verified
boolean
required

If the company is Whop Verified

​
business_type
enum<string> | null
required

The type of business the company is. The different business types a company can be.

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
industry_type
enum<string> | null
required

The specific industry the company operates in. The different industry types a company can be 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
​
created_at
string<date-time>
required

When the company was created (signed up)

Example:

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

​
updated_at
string<date-time>
required

The time the company was last updated.

Example:

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

​
member_count
integer
required

The number of members in the company.

Example:

42

​
owner_user
object
required

The user who owns this company

​
route
string
required

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

The company's logo.

​
published_reviews_count
integer
required

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

Example:

42

​
metadata
object | null
required

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

​
social_links
object[]
required

The social media accounts of the company