Skip to main content
{
	"api_key": {
		"created_at": "2023-12-01T05:00:00.401Z",
		"id": "<string>",
		"token": "<string>"
	},
	"app_type": "b2b_app",
	"base_url": "https://myapp.example.com",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe"
	},
	"creator": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	},
	"dashboard_path": "/experiences/[experienceId]",
	"description": "A comprehensive analytics dashboard for tracking revenue, members, and growth metrics.",
	"discover_path": "/experiences/[experienceId]",
	"domain_id": "ab1c2d3e4f5g6h7i8j9k",
	"experience_path": "/experiences/[experienceId]",
	"icon": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"id": "app_xxxxxxxxxxxxxx",
	"name": "Courses",
	"openapi_path": "/experiences/[experienceId]",
	"origin": "<string>",
	"redirect_uris": ["<string>"],
	"requested_permissions": [
		{
			"is_required": true,
			"justification": "<string>",
			"permission_action": {
				"action": "<string>",
				"name": "<string>"
			}
		}
	],
	"skills_path": "/experiences/[experienceId]",
	"stats": {
		"dau": 42,
		"mau": 42,
		"time_spent_last24_hours": 42,
		"wau": 42
	},
	"status": "live",
	"verified": true
}
​
api_key
object | null
required
The API key used to authenticate requests on behalf of this app. Null if no API key has been generated. Requires the ‘developer:manage_api_key’ permission.
​
app_type
AppTypes
required
The target audience classification for this app (e.g., ‘b2b_app’, ‘b2c_app’, ‘company_app’, ‘component’).Available options: b2b_app, b2c_app, company_app, component
​
base_url
string | null
required
The production base URL where the app is hosted. Null if no base URL is configured.Example: https://myapp.example.com
​
company
object
required
The company that owns and publishes this app.
​
creator
object
required
The user who created and owns the company that published this app.
​
dashboard_path
string | null
required
The URL path template for a specific view of this app, appended to the base domain (e.g., ‘/experiences/[experienceId]’). Null if the specified view type is not configured.Example: /experiences/[experienceId]
​
description
string | null
required
A written description of what this app does, displayed on the app store listing page. Null if no description has been set.Example: A comprehensive analytics dashboard for tracking revenue,…
​
discover_path
string | null
required
The URL path template for a specific view of this app, appended to the base domain (e.g., ‘/experiences/[experienceId]’). Null if the specified view type is not configured.Example: /experiences/[experienceId]
​
domain_id
string
required
The unique subdomain identifier for this app’s proxied URL on the Whop platform. Forms the URL pattern https://{domain_id}.apps.whop.com.Example: ab1c2d3e4f5g6h7i8j9k
​
experience_path
string | null
required
The URL path template for a specific view of this app, appended to the base domain (e.g., ‘/experiences/[experienceId]’). Null if the specified view type is not configured.Example: /experiences/[experienceId]
​
icon
object | null
required
The icon image for this app, displayed on the app store, product pages, checkout, and as the default icon for experiences using this app.
​
id
string
required
The unique identifier for the app.Example: app_xxxxxxxxxxxxxx
​
name
string
required
The display name of this app shown on the app store and in experience navigation. Maximum 30 characters.Example: Courses
​
openapi_path
string | null
required
The URL path template for a specific view of this app, appended to the base domain (e.g., ‘/experiences/[experienceId]’). Null if the specified view type is not configured.Example: /experiences/[experienceId]
​
origin
string | null
required
The full origin URL for this app’s proxied domain (e.g., ‘https://myapp.apps.whop.com’). Null if no proxy domain is configured.
​
redirect_uris
array<string>
required
The whitelisted OAuth callback URLs that users are redirected to after authorizing the app.
​
requested_permissions
array<object>
required
The list of permissions this app requests when installed, including both required and optional permissions with justifications.
​
skills_path
string | null
required
The URL path template for a specific view of this app, appended to the base domain (e.g., ‘/experiences/[experienceId]’). Null if the specified view type is not configured.Example: /experiences/[experienceId]
​
stats
object | null
required
Aggregate usage statistics for this app, including daily, weekly, and monthly active user counts.
​
status
AppStatuses
required
The current visibility status of this app on the Whop app store. ‘live’ means publicly discoverable, ‘unlisted’ means accessible only via direct link, and ‘hidden’ means not visible anywhere.Available options: live, unlisted, hidden
​
verified
boolean
required
Whether this app has been verified by Whop. Verified apps are endorsed by Whop and displayed in the featured apps section of the app store.