Skip to main content
GET
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

App ID (prefixed app_). Retrieval also accepts the app's claimed route, an active verified custom hostname, or its proxy domain id. A custom hostname returns 404 when its assignment is inactive or the app or its owning account is deleted.

Yanıt

app retrieved

account
object
gerekli

The account that owns the app.

api_key
object | null
gerekli

Legacy app API key used to authenticate requests on the app's behalf. null when no key exists or the caller lacks the developer:manage_api_key permission.

app_store_description
string | null
gerekli

Detailed description shown on the app store's in-depth app page, or null when none has been set.

Örnek:

"Shine Time Booking turns a whop into a booking calendar. Members pick a package, choose a slot that fits the day's route, and pay up front. A reminder goes out the night before and the receipt lands as soon as the job is signed off."

app_type
enum<string>
gerekli

The type of end-user the app is built for.

Mevcut seçenekler:
b2b_app,
b2c_app,
company_app,
component,
website
Örnek:

"b2c_app"

average_review_rating
number
gerekli

Average star rating across published reviews for this app, from 1.0 to 5.0. Returns 0.0 when no published-review rating is available.

Örnek:

0

banner_image
object | null
gerekli

Banner image from the app's product listing, or null when none is uploaded.

base_url
string | null
gerekli

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

Örnek:

"https://shine-time-booking.whop.site"

businesses_created_count
integer
gerekli

Website businesses created from this app as a template.

Örnek:

5

businesses_created_logo_urls
string[]
gerekli

Up to three logo image URLs from businesses created from this app as a template.

businesses_with_recent_sales_count
integer
gerekli

Website businesses created from this app as a template that processed a payment in the last 24 hours. Recounted hourly, so it can be up to an hour behind.

Örnek:

0

category
object | null
gerekli

The app's App Store category, or null when none has been set. An app can show a category that GET /apps/categories does not list, if it was categorized before the current store categories.

creator
object
gerekli

The user who owns the publishing account.

dashboard_path
string | null
gerekli

URL path for the account dashboard view, or null when not configured.

Örnek:

"/dashboard/[companyId]"

default_api_key
object | null
gerekli

The app's default API key. null when the app has no default key or the caller lacks the developer:manage_api_key permission; secret_key is additionally null unless the caller could have created the key themselves.

deployment
object | null
gerekli

What the app has left to publish, and how a publish in flight is going — status is only ever unpublished, publishing, or failed here. null means there is nothing to report: the app is fully published, there is no working copy to publish from, or the caller cannot deploy this app. Tell those apart from the app's own production_web_build.

description
string | null
gerekli

Short description shown in listings and search results, or null if none has been set.

Örnek:

"Let members book a mobile detailing appointment without leaving your whop."

discover_path
string | null
gerekli

URL path for the discover view, or null when not configured.

Örnek:

"/discover"

domain_id
string
gerekli

Subdomain identifier for the app's proxied URL, forming https://{domain_id}.apps.whop.com.

Örnek:

"whopappdomain0000001"

domains
object[]
gerekli
elements_used
enum<string>[]
gerekli

Whop Elements the app's production web build mounts, as <namespace>.<element> keys (sub-controller children take a third segment, e.g. payments.cardFields.cardNumber). A bare namespace means the build reaches that namespace but the individual elements could not be resolved. Empty when the build mounts none, when it has not been scanned yet, or when the app has no production web build.

Mevcut seçenekler:
ads,
ads.billing-setup,
ads.campaign-creator,
ads.reporting,
ads.reporting.chart,
ads.reporting.table,
checkout,
checkout.checkout,
checkout.expressCheckout,
payments,
payments.address,
payments.branding,
payments.card,
payments.cardFields,
payments.cardFields.cardCvc,
payments.cardFields.cardExpiry,
payments.cardFields.cardNumber,
payments.email,
payments.payment,
payments.taxId,
tracking,
tracking.events,
tracking.people,
wallet,
wallet.activity,
wallet.balances,
wallet.balances.balance,
wallet.balances.list,
wallet.cards,
wallet.deposit,
wallet.send,
wallet.withdraw,
websites,
websites.pixel-setup,
websites.websites
experience_path
string | null
gerekli

URL path for the member-facing hub view, or null when not configured.

Örnek:

"/experiences/[experienceId]"

hosted_url
string | null
gerekli
kullanımdan kaldırıldı

Full URL where the app's hosted web build is served, or null if no route is claimed. DEPRECATED: Read domains instead.

Örnek:

"https://shine-time-booking.whop.site"

icon
object
gerekli

The app's icon. Falls back to the default app icon when none is uploaded.

id
string
gerekli

App ID, prefixed app_.

Örnek:

"app_xxxxxxxxxxxxxx"

imported_from_url
string | null
gerekli

The address of the existing website this app was imported from, such as https://shop.example.com. null if the app was not imported from another site, or if the caller lacks the developer:basic:read permission on the app's account.

Örnek:

"https://shinetime.example"

is_app_store_listed
boolean
gerekli

Whether the app is published, approved, and visible in the public app store.

Örnek:

false

is_whop_app
boolean
gerekli

Whether Whop publishes this app.

Örnek:

false

marketplace_status
enum<string> | null
gerekli

Approval status of the app's product listing on the Whop app store, or null when the app has no associated product.

Mevcut seçenekler:
not_available,
pending_review,
live_marketplace,
null
Örnek:

"not_available"

name
string
gerekli

Display name shown on the app store and in experience navigation.

Örnek:

"Shine Time Booking"

oauth_client_type
enum<string>
gerekli

How the app authenticates at the OAuth token endpoint.

Mevcut seçenekler:
public,
confidential
Örnek:

"public"

openapi_path
string | null
gerekli

URL path to the app's OpenAPI spec file, or null when not configured.

Örnek:

"/openapi.json"

origin
string | null
gerekli

Full origin URL of the app's proxied domain, for example https://ab1c2d3e4f.apps.whop.com.

Örnek:

"https://whopappdomain0000001.apps.whop.com"

per_install_schedule
string | null
gerekli

Five-field cron expression, read in UTC, on which Whop runs the production web build's scheduled() export once for every installation, with the installation in ctx.props.app_installation, no more often than every 15 minutes. Slots are skipped while the app has no production web build with a server entry. null when the app has no per-install schedule, or if the caller lacks the developer:basic:read permission on the app's account.

Örnek:

"*/15 * * * *"

preview_token
string | null
gerekli

A short-lived signed pass scoping the caller to this app's gated preview hosts — every build preview and the live dev-server sandbox. Add it to a preview host as the __whop_preview query param (or x-whop-preview-token header). null unless the caller is a team member who can read the app's developer settings.

Örnek:

"whop_preview_pass_example"

product_category
string | null
gerekli

Product category a business built from this app as a template sells, such as pressure_washing, or null when none has been set.

Örnek:

null

product_id
string | null
gerekli

ID of the app's product listing on the Whop app store, or null when the app has no associated product.

Örnek:

"prod_xxxxxxxxxxxxxx"

production_android_build
object | null
gerekli

The approved build currently served on Android, or null when none is deployed.

production_ios_build
object | null
gerekli

The approved build currently served on iOS, or null when none is deployed.

production_web_build
object | null
gerekli

The approved build currently served on web, or null when none is deployed.

published_reviews_count
integer
gerekli

Published customer reviews for this app.

Örnek:

0

redirect_uris
string[]
gerekli

Whitelisted OAuth callback URLs users are redirected to after authorizing the app.

requested_permissions
object[]
gerekli
required_scopes
enum<string>[]
gerekli

Scopes the app asks a user to grant when they authorize it, shown on the consent screen.

Mevcut seçenekler:
read_user
route
string | null
gerekli
kullanımdan kaldırıldı

Claimed subdomain route where hosted web builds are served (myapp for myapp.whop.site), or null if no route is claimed. DEPRECATED: Read domains instead.

Örnek:

"shine-time-booking"

schedule
string | null
gerekli

Five-field cron expression, read in UTC, on which Whop runs the production web build's scheduled() export once per slot. Slots are skipped while the app has no production web build with a server entry. null when the app has no global schedule, or if the caller lacks the developer:basic:read permission on the app's account.

Örnek:

"0 * * * *"

secrets
object | null
gerekli

The app's production secrets as an object of string values, injected into the hosted server runtime. null when the caller lacks the developer:update_app permission.

Örnek:
skills_path
string | null
gerekli

URL path to the app's skills directory, or null when not configured.

Örnek:

"/skills"

status
enum<string>
gerekli

Visibility on the Whop app store: live is publicly discoverable, unlisted is accessible only via direct link, hidden is not visible anywhere.

Mevcut seçenekler:
live,
unlisted,
hidden
Örnek:

"unlisted"

verified
boolean
gerekli

Whether the app has been verified by Whop and is eligible for the featured apps section.

Örnek:

false