Sign in
Domains

List Domains

Lists the caller's domain claims and assignments. Filter by account, app, or lifecycle status.

get/domains

Query parameters

account_idstring

Only domains belonging to this account, prefixed biz_.

app_idstring

Only domains assigned to this app, prefixed app_.

status'pending_verification' | 'provisioning' | 'active' | 'action_required' | 'deleting' | 'removed'

Only domains with this lifecycle status.

order'created_at' | 'updated_at'

Field to sort by.

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.

Response

Domain list

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "app_id": "app_xxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "dns_records": [
        {
          "name": "_whop.shop.example.com",
          "type": "TXT",
          "value": "whop-domain-verification=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        }
      ],
      "dns_status": "pending",
      "domain": "shop.example.com",
      "id": "dom_xxxxxxxxxxxxxx",
      "issues": [
        {
          "code": "dns_required",
          "message": "Point DNS to Whop using the routing records. Disable other CDN proxies while connecting."
        }
      ],
      "metadata": {},
      "status": "deleting",
      "updated_at": "2026-01-01T12:00:00.000Z",
      "verification_expires_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 2 of the 74 revisions of this API.121

  • ff3a7657356312See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

  • 2a25564a92d51See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.