Skip to main content
GET
/
apps
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const appListResponse of client.apps.list()) {
  console.log(appListResponse.id);
}
{
  "data": [
    {
      "id": "app_xxxxxxxxxxxxxx",
      "name": "<string>",
      "description": "<string>",
      "status": "live",
      "base_url": "https://example.com/path",
      "domain_id": "<string>",
      "verified": true,
      "app_type": "b2b_app",
      "experience_path": "<string>",
      "discover_path": "<string>",
      "dashboard_path": "<string>",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>"
      },
      "icon": {
        "url": "<string>"
      },
      "creator": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Query Parameters

​
app_type
enum<string> | null

Filter apps by the type of end-user they are built for.

Available options:
b2b_app,
b2c_app,
company_app,
component
​
company_id
string | null

The ID of the company to filter apps by

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The direction of the order

Available options:
asc,
desc
​
order
enum<string> | null

The order to fetch the apps in. The default is discoverable at descending, aka show the most recent apps to become discoverable on the app store.

Available options:
discoverable_at,
total_installs_last_30_days,
total_installs_last_7_days,
time_spent,
time_spent_last_24_hours,
daily_active_users
​
query
string | null

The query to search for apps by name.

​
verified_apps_only
boolean | null

If true, you will only get apps that are verified by Whop. Use this to populate a 'featured apps' section on the app store.

​
view_type
enum<string> | null

Filter apps by the view type they support. For example this can be used to only fetch apps that support the 'dashboard' view for the creator dashboard.

Available options:
hub,
discover,
dash,
dashboard,
analytics
​
after
string | null

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

​
before
string | null

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

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

Response

A successful response

The connection type for PublicApp.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.