WHwhop
App Installations

List App Installations

Changed on

Lists app installations, newest first. An app's API key lists the accounts that installed it. An account lists the apps installed on it; a user passes that account's account_id. The developer of an app lists every installation of it by passing app_id. Uninstalled apps, deleted apps and deleted accounts are left out.

get/app_installations

Request

  • Base URL
    https://api.whop.com/api/v1
  • URL
    https://api.whop.com/api/v1/app_installations
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Query parameters

account_idstring

Only return installations on this account, prefixed biz_.

app_idstring

Only return installations of this app, prefixed app_. Pass your own app's ID to list the accounts that installed it.

view_type'hub' | 'discover' | 'dash' | 'dashboard' | 'analytics' | 'skills' | 'openapi'

Only return installations of apps that have this view, such as dashboard for apps shown in a business's dashboard.

external_idstring

Only return the installation with this external_id, the installed app's own identifier for it. Only the app and its developer can filter by it.

created_beforestring

Only return installations created before this ISO 8601 timestamp.

created_afterstring

Only return installations created after this ISO 8601 timestamp.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order'created_at' | 'name'

Field to sort installations by. name sorts by app name, and only when listing the apps installed on one account.

direction'asc' | 'desc'

Sort direction.

Response

app installations listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Acme Bookkeeping"
      },
      "app": {
        "developer": {
          "id": "biz_xxxxxxxxxxxxxx",
          "title": "Acme Bookkeeping"
        },
        "icon": {
          "url": "https://pub-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.dev/custom-perk-icon.svg"
        },
        "id": "app_xxxxxxxxxxxxxx",
        "name": "Other App"
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "external_id": "acme-books",
      "id": "aag_xxxxxxxxxxxxxx",
      "metadata": {
        "last_synced_at": "2026-01-01T12:00:00.000Z",
        "quickbooks_realm_id": "9341452712"
      },
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 7777af2c99e5Revision changes
    • info

      the security scope developer:app_installation:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope developer:basic:read was removed from the endpoint's security scheme bearerAuth

  • dfe1a28eca1dRevision changes
    • info

      the security scope developer:app_installation:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope developer:basic:read was removed from the endpoint's security scheme bearerAuth