Skip to main content
GET
Retrieve app
This page documents the Legacy API. For new integrations, use Retrieve App in the Current API.
Required permissions:
  • developer:manage_api_key
  • developer:basic:read
  • developer:update_app

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

developer:manage_api_key
developer:basic:read
developer:update_app

Yol Parametreleri

id
string
gerekli

The unique identifier of the app to retrieve.

Örnek:

"app_xxxxxxxxxxxxxx"

Yanıt

A successful response

An app is an integration built on Whop. Apps can serve consumers as experiences within products, or serve companies as business tools.

api_key
object | null
gerekli

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
enum<string>
gerekli

The target audience classification for this app (e.g., 'b2b_app', 'b2c_app', 'company_app', 'component').

Mevcut seçenekler:
b2b_app,
b2c_app,
company_app,
component,
website
base_url
string | null
gerekli

The production base URL where the app is hosted. null if no base URL is configured, or if the caller lacks the developer:basic:read permission on the app's account.

Örnek:

"https://myapp.example.com"

company
object
gerekli

The company that owns and publishes this app.

creator
object
gerekli

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

dashboard_path
string | null
gerekli

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.

Örnek:

"/experiences/[experienceId]"

default_api_key
object | null
gerekli

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.

description
string | null
gerekli

A written description of what this app does, displayed on the app store listing page. Null if no description has been set.

Örnek:

"A comprehensive analytics dashboard for tracking revenue, members, and growth metrics."

discover_path
string | null
gerekli

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.

Örnek:

"/experiences/[experienceId]"

domain_id
string
gerekli

The unique subdomain identifier for this app's proxied URL on the Whop platform. Forms the URL pattern https://{domain_id}.apps.whop.com.

Örnek:

"ab1c2d3e4f5g6h7i8j9k"

experience_path
string | null
gerekli

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.

Örnek:

"/experiences/[experienceId]"

hosted_url
string | null
gerekli

The full canonical URL where this app's hosted web build is served. Null if the app has not claimed a route.

Örnek:

"https://myapp.whop.site"

icon
object | null
gerekli

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
gerekli

The unique identifier for the app.

Örnek:

"app_xxxxxxxxxxxxxx"

marketplace_status
enum<string> | null
gerekli

The approval status of this app's product listing on the Whop app store. Null if the app has no associated product.

Mevcut seçenekler:
not_available,
pending_review,
live_marketplace
name
string
gerekli

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

Örnek:

"Courses"

oauth_client_type
enum<string>
gerekli

How this app authenticates when exchanging OAuth authorization and refresh grants.

Mevcut seçenekler:
public,
confidential
openapi_path
string | null
gerekli

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.

Örnek:

"/experiences/[experienceId]"

origin
string | null
gerekli

The full origin URL for this app's proxied domain (e.g., 'https://myapp.apps.whop.com'). Null if no proxy domain is configured.

product_id
string | null
gerekli

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

production_web_build
object | null
gerekli

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

redirect_uris
string[]
gerekli

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

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

requested_permissions
object[]
gerekli

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

route
string | null
gerekli

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

Örnek:

"myapp"

secrets
object | null
gerekli

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.

skills_path
string | null
gerekli

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.

Örnek:

"/experiences/[experienceId]"

stats
object | null
gerekli

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

status
enum<string>
gerekli

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.

Mevcut seçenekler:
live,
unlisted,
hidden
verified
boolean
gerekli

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.