Skip to main content
GET
Retrieve Domain

Authorizations

Authorization
string
header
required

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

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-09"

Path Parameters

id
string
required

Domain ID, prefixed dom_.

Response

200 - application/json

Domain details

account_id
string
required

ID of the account claiming or owning this domain, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

app_id
string
required

ID of the app assigned to this domain, prefixed app_.

Example:

"app_xxxxxxxxxxxxxx"

certificate_status
string | null
required

Cloudflare's latest certificate issuance status.

created_at
string
required

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

Example:

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

dns_records
object[]
required
dns_status
enum<string>
required

Result of the most recent DNS routing check. Ownership is verified separately.

Available options:
pending,
valid,
invalid,
unknown
Example:

"pending"

domain
string
required

Normalized hostname, such as checkout.example.com.

Example:

"shop.example.com"

hostname_status
string | null
required

Cloudflare's latest hostname activation status.

id
string
required

Domain ID, prefixed dom_.

Example:

"dom_xxxxxxxxxxxxxx"

issues
object[]
required
last_checked_at
string | null
required

When DNS and provider state were last checked, as an ISO 8601 timestamp.

metadata
object
required

Custom string keys and values attached to this domain.

Example:
status
enum<string>
required

Domain lifecycle. Only active domains resolve to their app.

Available options:
pending_verification,
provisioning,
active,
action_required,
deleting,
removed
Example:

"deleting"

updated_at
string
required

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

Example:

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

verification_expires_at
string | null
required

When an unverified claim is automatically deleted, 48 hours after creation, as an ISO 8601 timestamp.

Example:

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

verified_at
string | null
required

When Whop verified the ownership TXT record, as an ISO 8601 timestamp.