GET
/
v5
/
app
/
companies
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v5/app/companies/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": 123,
  "title": "<string>",
  "image_url": "<string>",
  "authorized_user": {
    "id": "<string>",
    "username": "<string>",
    "email": "<string>",
    "role": "<string>"
  },
  "has_payment_method": true,
  "route": "<string>"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the Company, which will look like biz_*************

Response

200 - application/json
id
string
required

The ID of the company object, which will look like biz_*************

created_at
number
required

The date the company was created as a unix timestamp.

title
string
required

The title of the company

image_url
string

The URL of the company's image

authorized_user
object
has_payment_method
boolean

Whether or not the company has a payment method on file to charge for metered billing usage.

route
string

The route to the company's first/default page