Companies
Retrieve a Company
Returns a company
GET
/
v5
/
app
/
companies
/
{id}
Authorization
Path
curl --request GET \
--url https://api.whop.com/api/v5/app/companies/{id} \
--header 'Authorization: <authorization>'
{
"authorized_user": {
"email": "<string>",
"id": "<string>",
"role": "<string>",
"username": "<string>"
},
"created_at": 123,
"has_payment_method": true,
"id": "<string>",
"image_url": "<string>",
"title": "<string>"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredThe ID of the Company, which will look like biz_*************
Response
200 - application/json
authorized_user
object
created_at
number
requiredThe date the company was created as a unix timestamp.
has_payment_method
boolean
Whether or not the company has a payment method on file to charge for metered billing usage.
id
string
requiredThe ID of the company object, which will look like biz_*************
image_url
string
The URL of the company's image
title
string
requiredThe title of the company
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v5/app/companies/{id} \
--header 'Authorization: <authorization>'
{
"authorized_user": {
"email": "<string>",
"id": "<string>",
"role": "<string>",
"username": "<string>"
},
"created_at": 123,
"has_payment_method": true,
"id": "<string>",
"image_url": "<string>",
"title": "<string>"
}