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

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

const app = await client.apps.retrieve('app_xxxxxxxxxxxxxx');

console.log(app.id);
{
  "id": "app_xxxxxxxxxxxxxx",
  "name": "<string>",
  "description": "<string>",
  "status": "live",
  "base_url": "https://example.com/path",
  "domain_id": "<string>",
  "verified": true,
  "experience_path": "<string>",
  "discover_path": "<string>",
  "dashboard_path": "<string>",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>"
  },
  "icon": {
    "url": "<string>"
  },
  "creator": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "<string>",
    "username": "<string>"
  },
  "requested_permissions": [
    {
      "permission_action": {
        "action": "<string>",
        "name": "<string>"
      },
      "is_required": true,
      "justification": "<string>"
    }
  ],
  "stats": {
    "dau": 42,
    "mau": 42,
    "time_spent_last24_hours": 42,
    "wau": 42
  },
  "api_key": {
    "id": "<string>",
    "token": "<string>",
    "created_at": "2023-12-01T05:00:00.401Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
Example:

"app_xxxxxxxxxxxxxx"

Response

A successful response

An object representing an app

​
id
string
required

The ID of the app

Example:

"app_xxxxxxxxxxxxxx"

​
name
string
required

The name of the app

​
description
string | null
required

The description of the app

​
status
enum<string>
required

If the status is live, the app is visible on Whop discovery. In order to be live, you need to set the name, icon, and description. Being unlisted or hidden means it's not visible on Whop but you can still install the app via direct link. To remove the app from whop discovery, you should set the status to unlisted.

Available options:
live,
unlisted,
hidden
​
base_url
string | null
required

The base url of the app

Example:

"https://example.com/path"

​
domain_id
string
required

The unique part of the proxied domain for this app. Used to generate the base url used to display the app inside the whop platform. Refers to the id part in the final url: https://{domain_id}.apps.whop.com

​
verified
boolean
required

Whether this app has been verified by Whop. Verified apps are endorsed by whop and are shown in the 'featured apps' section of the app store.

​
experience_path
string | null
required

The path part for a specific view of the app. This is the template part of the url after the base domain. Eg: /experiences/[experienceId]

​
discover_path
string | null
required

The path part for a specific view of the app. This is the template part of the url after the base domain. Eg: /experiences/[experienceId]

​
dashboard_path
string | null
required

The path part for a specific view of the app. This is the template part of the url after the base domain. Eg: /experiences/[experienceId]

​
company
object
required

The company that owns the app

​
icon
object | null
required

The icon for the app. This icon is shown on discovery, on the product page, on checkout, and as a default icon for the experiences.

​
creator
object
required

The creator of the app

​
requested_permissions
object[]
required

The set of permissions that an app requests to be granted when a user installs the app.

​
stats
object | null
required

A collection of stats for the app.

​
api_key
object | null
required

The API key for the app

⌘I