GET
/
v5
/
app
/
companies
Authorization
Query
curl --request GET \
  --url https://api.whop.com/api/v5/app/companies \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "authorized_user": {
        "email": "<string>",
        "id": "<string>",
        "role": "<string>",
        "username": "<string>"
      },
      "created_at": 123,
      "has_payment_method": true,
      "id": "<string>",
      "image_url": "<string>",
      "title": "<string>"
    }
  ],
  "pagination": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
headerrequired

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

Query Parameters

page
integer
default: 1

The page number to retrieve

per
integer
default: 10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json
data
object[]
required
pagination
object
required

Was this page helpful?

OverviewRetrieve a Company