Skip to main content
GET
/
companies
/
{id}
Retrieve company
curl --request GET \
  --url https://api.whop.com/api/v1/companies/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.whop.com/api/v1/companies/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.whop.com/api/v1/companies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.whop.com/api/v1/companies/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/companies/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/companies/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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",
    "name": "<string>"
  },
  "id": "biz_xxxxxxxxxxxxxx",
  "logo": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "member_count": 42,
  "metadata": {},
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "published_reviews_count": 42,
  "route": "pickaxe",
  "send_customer_emails": true,
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "https://x.com/whop"
    }
  ],
  "target_audience": "<string>",
  "title": "Pickaxe",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "verified": true
}
{
"error": {
"code": "parameter_missing",
"message": "Missing required parameter: amount.",
"param": "amount",
"type": "invalid_request_error"
}
}
{
"error": {
"message": "Invalid or missing API key",
"type": "unauthorized"
}
}
{
"error": {
"message": "You do not have permission to access this resource",
"type": "forbidden"
}
}
{
"error": {
"message": "Resource not found",
"type": "not_found"
}
}
{
"error": null
}
{
"error": null
}
{
"error": {
"message": "An unexpected error occurred",
"type": "internal_server_error"
}
}

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.

affiliate_instructions
string | null
required

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

Example:

"Share your unique link on social media to earn 20% commission."

created_at
string<date-time>
required

The datetime the company was created.

Example:

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

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

The product featured for affiliates to promote on this company's affiliate page. Null if none is configured.

id
string
required

The unique identifier for the company.

Example:

"biz_xxxxxxxxxxxxxx"

logo
object | null
required

The company's logo.

member_count
integer
required

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

Example:

42

metadata
object | null
required

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

owner_user
object
required

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

published_reviews_count
integer
required

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

Example:

42

route
string
required

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

Example:

"pickaxe"

send_customer_emails
boolean
required

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

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

target_audience
string | null
required

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

title
string
required

The display name of the company shown to customers.

Example:

"Pickaxe"

updated_at
string<date-time>
required

The datetime the company was last updated.

Example:

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

verified
boolean
required

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