Skip to main content
GET
Retrieve Domain

Autorizaciones

Authorization
string
header
requerido

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.

Scopes

domain:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

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

Respuesta

Domain details

account_id
string | null
requerido

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

Ejemplo:

"biz_xxxxxxxxxxxxxx"

apple_pay
object | null
requerido

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

availability
object | null
requerido

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

created_at
string | null
requerido

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

Ejemplo:

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

domain
string
requerido

Normalized hostname, such as checkout.example.com.

Ejemplo:

"shop.com"

email
object | null
requerido

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
requerido

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

Ejemplo:

"dom_xxxxxxxxxxxxxx"

issues
object[]
requerido
metadata
object
requerido

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

Ejemplo:
owned_by
object | null
requerido

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

pixel
object | null
requerido

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

platform
object | null
requerido

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
requerido

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
requerido

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

stats
object | null
requerido

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

status
enum<string> | null
requerido

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

Opciones disponibles:
idle,
pending,
ready,
action_required,
releasing,
null
Ejemplo:

"pending"

subdomain
object | null
requerido

A subdomain of a domain this account bought through Whop, whose DNS Whop runs. Whop removes it when the account no longer holds the root domain. null for other domains or when not visible to you.

transfer
object | null
requerido

Moving the domain to another Whop account. null when not turned on or not visible to you.

updated_at
string | null
requerido

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

Ejemplo:

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

verification
object | null
requerido

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

website
object | null
requerido

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