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

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

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

console.log(company.id);
{
  "id": "biz_xxxxxxxxxxxxxx",
  "title": "Pickaxe",
  "description": "Learn the fundamentals of data analytics with hands-on projects.",
  "verified": true,
  "business_type": "education_program",
  "industry_type": "trading",
  "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": {},
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "https://x.com/whop",
      "website": "x"
    }
  ]
}

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 ***************************

Path Parameters

​
id
string
required

The unique identifier or route slug of the company.

Example:

"biz_xxxxxxxxxxxxxx"

Response

A successful response

A company is a seller on Whop. Companies own products, manage members, and receive payouts.

​
id
string
required

The unique identifier for the company.

Example:

"biz_xxxxxxxxxxxxxx"

​
title
string
required

The display name of the company shown to customers.

Example:

"Pickaxe"

​
description
string | null
required

A promotional pitch written by the company creator, displayed to potential customers on the store page.

Example:

"Learn the fundamentals of data analytics with hands-on projects."

​
verified
boolean
required

Whether this company has been verified by Whop's trust and safety team.

​
business_type
enum<string> | null
required

The high-level business category for the company (e.g., education_program, coaching, software). Null if not classified.

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 vertical the company operates in (e.g., fitness, trading, real_estate). Null if not classified.

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
​
send_customer_emails
boolean
required

Whether Whop sends transactional emails (receipts, updates) to customers on behalf of this company.

​
created_at
string<date-time>
required

The datetime the company was created.

Example:

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

​
updated_at
string<date-time>
required

The datetime the company was last updated.

Example:

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

​
member_count
integer
required

The total number of users who currently hold active memberships across all of this company's products.

Example:

42

​
owner_user
object
required

The user who owns and has full administrative control over this company.

​
route
string
required

The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).

Example:

"pickaxe"

​
logo
object
required

The company's logo.

​
published_reviews_count
integer
required

The total number of published customer reviews across all products for this company.

Example:

42

​
metadata
object
required

A key-value JSON object of custom metadata for this company, managed by the platform that created the account.

​
social_links
object[]
required

The list of social media accounts and external links associated with this company.