- Overview
Companies
Experiences
Memberships
Products
Payments
Reviews
Notifications
Line Items
App Connections
Users
Billing Usages
- GETRetrieve the current app
- GETCheck Access
- Overview
Memberships
Products
Payments
Reviews
Experiences
Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Apps
Me
List Companies
Returns a collection of companies
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
curl --request GET \
--url https://api.whop.com/api/v5/app/companies \
--header 'Authorization: Bearer <token>'
{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
Response
Current page number
Total number of pages
Next page number
Previous page number
Total number of records
The ID of the company object, which will look like biz_*************
The date the company was created as a unix timestamp.
The title of the company
The URL of the company's image
The ID of the user, which will look like user_*************
The username of the authorized user
The email of the authorized user
The role of the user
Whether or not the company has a payment method on file to charge for metered billing usage.
The route to the company's first/default page
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v5/app/companies \
--header 'Authorization: Bearer <token>'
{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"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>"
}
]
}