Skip to main content
GET
Retrieve Domain

Authorizations

Authorization
string
header
required

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.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Path Parameters

id
string
required

Domain ID, prefixed dom_, or a hostname such as example.com; a bare name looks up .com.

Response

Domain details

account_id
string | null
required

ID of the account the domain belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

apple_pay
object | null
required

Offering Apple Pay at checkouts served from the domain. null when not enrolled or not visible to you.

availability
object | null
required

Whether you can register the hostname and what it costs. Set only when no domain on Whop has it.

created_at
string | null
required

When the domain was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

domain
string
required

Normalized hostname, such as checkout.example.com.

Example:

"shop.com"

email
object | null
required

Sending and receiving email on the domain through Whop. null when not wanted, or when the domain belongs to an account you can't read.

id
string | null
required

Domain ID, prefixed dom_. null when no domain on Whop has this hostname.

Example:

"dom_xxxxxxxxxxxxxx"

issues
object[]
required
metadata
object
required

Custom string keys and values attached to this domain. Empty when the domain isn't yours.

Example:
owned_by
object | null
required

The account that has proven it owns this hostname on Whop, which can be your own. null when no account has.

pixel
object | null
required

Tracking page views on the domain with the Whop pixel. null when not tracked or not visible to you.

platform
object | null
required

An address on a zone Whop runs, such as example.whop.site, that follows its app's route. null for other domains or when not visible to you.

public_record
object | null
required

The domain's public registration record (RDAP), read when you retrieve it by hostname. null for domains on Whop, available domains, or a record that couldn't be read.

registration
object | null
required

Buying the domain through Whop, renewing it, and running its DNS. null when not wanted or not visible to you.

stats
object | null
required

Traffic on the domain. null when the domain isn't on Whop or isn't visible to you.

status
enum<string> | null
required

The most pressing state of the domain's capabilities: releasing, then action_required, then pending, then ready. idle when it wants nothing.

Available options:
idle,
pending,
ready,
action_required,
releasing,
null
Example:

"pending"

updated_at
string | null
required

When the domain was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

verification
object | null
required

Proving you control the domain's DNS with a TXT record. null when not wanted or not visible to you.

website
object | null
required

Serving a Whop website on the domain. null when not wanted.