WHwhop
Domains

List Domains

Changed on

Lists your domains. Filter by account, app, status, hostname, or the state of a capability.

Pass search to find domains to buy instead: the exact domain first, even when taken, then your name on popular extensions, then suggestions. Pass tlds to check only the extensions you choose. Results aren't reserved.

get/domains

Request

  • Base URL
    https://api.whop.com/api/v1
  • URL
    https://api.whop.com/api/v1/domains
  • Auth
    HTTP bearer

Query parameters

account_idstring

Only domains belonging to this account, prefixed biz_.

app_idstring

Only domains whose website serves this app, prefixed app_.

status'idle' | 'pending' | 'ready' | 'action_required' | 'releasing'

Only domains with this status: the most pressing state of their capabilities, or idle when they want nothing.

order'unique_visitors_last_7_days' | 'created_at' | 'updated_at' | 'domain'

Field to sort by. Domains with the same value keep their creation order in the same direction.

direction'asc' | 'desc'

Sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

searchstring

A name or domain to find domains to buy, such as example or example.com; a subdomain or URL searches its registrable domain. Returns domains with availability instead of your domains, without other filters or pagination.

tldsstring[]

With search, check only these extensions, such as com or co.uk, returned in this order. Repeat for several, up to 100.

[
  "com"
]
domainstring

Only your domain with this hostname, such as example.com.

verification'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with verification in this state, such as ready, or any for every domain that has verification.

registration'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with registration in this state, such as ready, or any for every domain that has registration.

platform'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with platform in this state, such as ready, or any for every domain that has platform.

website'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with website in this state, such as ready, or any for every domain that has website.

apple_pay'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with apple_pay in this state, such as ready, or any for every domain that has apple_pay.

pixel'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with pixel in this state, such as ready, or any for every domain that has pixel.

email'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with email in this state, such as ready, or any for every domain that has email.

transfer'pending' | 'ready' | 'action_required' | 'releasing' | 'any'

Only domains with transfer in this state, such as ready, or any for every domain that has transfer.

Response

Domain list

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "apple_pay": {
        "state": "pending"
      },
      "availability": {
        "available": true,
        "price": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "renewal_price": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "score": 75,
        "transfer_price": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        }
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "domain": "shop.example.com",
      "email": {
        "state": "pending"
      },
      "id": "dom_xxxxxxxxxxxxxx",
      "issues": [
        {
          "capability": "verification",
          "code": "verification_required",
          "dns_records": [
            {
              "name": "_whop.shop.example.com",
              "type": "TXT",
              "value": "whop-domain-verification=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            }
          ],
          "message": "Publish this TXT record to prove you own the domain. Verification runs automatically."
        }
      ],
      "metadata": {},
      "owned_by": {
        "id": "biz_xxxxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Rival Shop"
      },
      "pixel": {
        "state": "pending"
      },
      "platform": {
        "state": "pending"
      },
      "registration": {
        "amount_due": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "auto_renew": true,
        "method": "transfer",
        "phase": "awaiting_payment",
        "purchase_url": "https://whop.com/checkout/ch_xxxxxxxxxxxxxx/",
        "renewal_price": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "state": "pending"
      },
      "status": "pending",
      "transfer": {
        "destination": "internal",
        "state": "ready"
      },
      "updated_at": "2026-01-01T12:00:00.000Z",
      "verification": {
        "state": "pending",
        "verification_expires_at": "2026-01-01T12:00:00.000Z"
      },
      "website": {
        "app": {
          "base_url": "https://domains-spec-site.whop.site",
          "id": "app_xxxxxxxxxxxxxx"
        },
        "state": "pending"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • a9f2f76c03fbRevision changes
    • warning

      added the new transfer enum value to the //// response property for the response status

    • info

      added the new optional query request parameter transfer

    • info

      added the required property // to the response with the status

  • 4dd9c67dccc2Revision changes
    • info

      added the required property /////// to the response with the status