Sign in
Companies

List companies

Returns a paginated list of companies. When parent_company_id is provided, lists connected accounts under that platform. When omitted, lists companies the current user has access to.

Required permissions:

  • company:basic:read
get/companies

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
parent_company_idstring

The unique identifier of the parent platform company. When provided, lists connected accounts under that platform. Omit to list the current user's own companies.

direction'asc' | 'desc'

The direction of the sort.

created_beforestring date-time

Only return companies created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time

Only return companies created after this timestamp.

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

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "description": "Learn the fundamentals of data analytics with hands-on projects.",
      "id": "biz_xxxxxxxxxxxxxx",
      "logo": {
        "url": "https://media.whop.com/abc123/optimized.jpg"
      },
      "member_count": 42,
      "owner_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "published_reviews_count": 42,
      "route": "pickaxe",
      "title": "Pickaxe",
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ]
}

Changes

Changed in 1 of the 41 revisions of this API.13

  • f67a043e319013See the full diff
    • ▲

      the query request parameter direction was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value asc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      for the query request parameter direction, the type/format was generalized from / to string/

      request-parameter-type-generalized