App

{
	"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]",
	"default_api_key": {
		"id": "<string>",
		"name": "<string>",
		"obfuscated_secret_key": "<string>",
		"secret_key": "<string>"
	},
	"description": "A comprehensive analytics dashboard for tracking revenue, members, and growth metrics.",
	"discover_path": "/experiences/[experienceId]",
	"domain_id": "ab1c2d3e4f5g6h7i8j9k",
	"experience_path": "/experiences/[experienceId]",
	"hosted_url": "https://myapp.whop.app",
	"icon": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"id": "app_xxxxxxxxxxxxxx",
	"marketplace_status": "not_available",
	"name": "Courses",
	"oauth_client_type": "public",
	"openapi_path": "/experiences/[experienceId]",
	"origin": "<string>",
	"product_id": "<string>",
	"production_web_build": {
		"checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
		"file_url": "https://cdn.whop.com/builds/abc123.zip",
		"id": "apbu_xxxxxxxxxxxxx",
		"source_url": "https://cdn.whop.com/builds/abc123-source.zip",
		"status": "draft"
	},
	"redirect_uris": ["<string>"],
	"requested_permissions": [
		{
			"is_required": true,
			"justification": "<string>",
			"permission_action": {
				"action": "<string>",
				"name": "<string>"
			}
		}
	],
	"route": "myapp",
	"secrets": {},
	"skills_path": "/experiences/[experienceId]",
	"stats": {
		"dau": 42,
		"mau": 42,
		"time_spent_last24_hours": 42,
		"wau": 42
	},
	"status": "live",
	"verified": true
}

{
	"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]",
	"default_api_key": {
		"id": "<string>",
		"name": "<string>",
		"obfuscated_secret_key": "<string>",
		"secret_key": "<string>"
	},
	"description": "A comprehensive analytics dashboard for tracking revenue, members, and growth metrics.",
	"discover_path": "/experiences/[experienceId]",
	"domain_id": "ab1c2d3e4f5g6h7i8j9k",
	"experience_path": "/experiences/[experienceId]",
	"hosted_url": "https://myapp.whop.app",
	"icon": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"id": "app_xxxxxxxxxxxxxx",
	"marketplace_status": "not_available",
	"name": "Courses",
	"oauth_client_type": "public",
	"openapi_path": "/experiences/[experienceId]",
	"origin": "<string>",
	"product_id": "<string>",
	"production_web_build": {
		"checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
		"file_url": "https://cdn.whop.com/builds/abc123.zip",
		"id": "apbu_xxxxxxxxxxxxx",
		"source_url": "https://cdn.whop.com/builds/abc123-source.zip",
		"status": "draft"
	},
	"redirect_uris": ["<string>"],
	"requested_permissions": [
		{
			"is_required": true,
			"justification": "<string>",
			"permission_action": {
				"action": "<string>",
				"name": "<string>"
			}
		}
	],
	"route": "myapp",
	"secrets": {},
	"skills_path": "/experiences/[experienceId]",
	"stats": {
		"dau": 42,
		"mau": 42,
		"time_spent_last24_hours": 42,
		"wau": 42
	},
	"status": "live",
	"verified": true
}

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.

Show child attributes

string<date-time>

required

The datetime the private api key was created.Example: 2023-12-01T05:00:00.401Z

string

required

The unique identifier for the private api key.

string

required

This is the API key used to authenticate requests

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, website

string | null

required

The production base URL where the app is hosted. Null if no base URL is configured.Example: https://myapp.example.com

object

required

The company that owns and publishes this app.

Show child attributes

string

required

The unique identifier for the company.Example: biz_xxxxxxxxxxxxxx

string

required

The display name of the company shown to customers.Example: Pickaxe

object

required

The user who created and owns the company that published this app.

Show child attributes

string

required

The unique identifier for the user.Example: user_xxxxxxxxxxxxx

string | null

required

The user’s display name shown on their public profile.Example: John Doe

string

required

The user’s unique username shown on their public profile.Example: johndoe42

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]

object | null

required

The app’s default API key, used to authenticate requests on behalf of this app. Null if the app has no default key. Requires the ‘developer:manage_api_key’ permission.

Show child attributes

string

required

The unique identifier for the authorized api key.

string | null

required

A user set name to identify an API key

string

required

A masked version of the secret key used to authenticate requests. This is so that the owner can easily identify which key it is without being shown the full secret.

string | null

required

The secret key used to authenticate requests. This is only available if the current actor would have been able to create this api key.

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,…

string | null

required

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

string | null

required

string | null

required

The full canonical URL where this app’s hosted web build is served. Null if the app has not claimed a route.Example: https://myapp.whop.app

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.

Show child attributes

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

string

required

The unique identifier for the app.Example: app_xxxxxxxxxxxxxx

MarketplaceStatuses | null

required

The approval status of this app’s product listing on the Whop app store. Null if the app has no associated product.Available options: not_available, pending_review, live_marketplace

string

required

The display name of this app shown on the app store and in experience navigation. Maximum 30 characters.Example: Courses

AppOauthClientTypes

required

How this app authenticates when exchanging OAuth authorization and refresh grants.Available options: public, confidential

string | null

required

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.

string | null

required

object | null

required

The approved app build currently served to users on web. Null if no production build is deployed for web.

Show child attributes

string

required

A SHA-256 hash of the uploaded build file, generated by the client and used to verify file integrity.Example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7…

string

required

A URL to download the app build as a .zip archive.Example: https://cdn.whop.com/builds/abc123.zip

string

required

The unique identifier for the app build.Example: apbu_xxxxxxxxxxxxx

string | null

required

A URL to download the compressed source code archive that produced this build. Null if the build was uploaded without a source archive.Example: https://cdn.whop.com/builds/abc123-source.zip

AppBuildStatuses

required

The current review status of this build.Available options: draft, pending, approved, rejected

array<string>

required

The whitelisted OAuth callback URLs that users are redirected to after authorizing the app.

array<object>

required

The list of permissions this app requests when installed, including both required and optional permissions with justifications.

Show child attributes

boolean

required

Whether the action is required for the app to function.

string

required

The reason for requesting the action.

object

required

The action that the app will request off of users when a user installs the app.

Show child attributes

string

required

The identifier of the action.

string

required

The human readable name of the action.

string | null

required

The unique subdomain route where this app’s hosted web builds are served, such as ‘myapp’ for myapp.whop.app. Null if the app has not claimed a route.Example: myapp

object | null

required

The app’s secrets as an object of string values. Encrypted at rest and injected into the app’s hosted server runtime as environment bindings. Requires the ‘developer:update_app’ permission.

string | null

required

object | null

required

Aggregate usage statistics for this app, including daily, weekly, and monthly active user counts.

Show child attributes

integer

required

The number of unique users who have spent time in this app in the last 24 hours. Returns 0 if no usage data is available.Example: 42

integer

required

The number of unique users who have spent time in this app in the last 28 days. Returns 0 if no usage data is available.Example: 42

integer

required

The total time, in seconds, that all users have spent in this app over the last 24 hours. Returns 0 if no usage data is available.Example: 42

integer

required

The number of unique users who have spent time in this app in the last 7 days. Returns 0 if no usage data is available.Example: 42

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

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.

⌘I

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats