Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Companies

Retrieve company

Retrieves the details of an existing company.

Required permissions:

  • company:basic:read
get/companies/{id}

Path parameters

idstring required
Example:biz_xxxxxxxxxxxxxx

The unique identifier or route slug of the company.

Response

A successful response

affiliate_instructionsstring nullable required

Guidelines and instructions provided to affiliates explaining how to promote this company's products.

created_atstring date-time required

The datetime the company was created.

descriptionstring nullable required

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

idstring required

The unique identifier for the company.

member_countinteger required

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

metadataobject nullable required

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

published_reviews_countinteger required

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

routestring required

URL slug for the account's store page, e.g. pickaxe in whop.com/pickaxe.

send_customer_emailsboolean required

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

target_audiencestring nullable required

The target audience for the company. Null if not set.

titlestring required

The display name of the company shown to customers.

updated_atstring date-time required

The datetime the company was last updated.

verifiedboolean required

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

Example response

{
  "affiliate_instructions": "Share your unique link on social media to earn 20% commission.",
  "created_at": "2023-12-01T05:00:00.401Z",
  "description": "Learn the fundamentals of data analytics with hands-on projects.",
  "featured_affiliate_product": {
    "id": "prod_xxxxxxxxxxxxx"
  },
  "id": "biz_xxxxxxxxxxxxxx",
  "logo": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "member_count": 42,
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "published_reviews_count": 42,
  "route": "pickaxe",
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "https://x.com/whop"
    }
  ],
  "title": "Pickaxe",
  "updated_at": "2023-12-01T05:00:00.401Z"
}