Access tokens1

Account links1

Accounts20

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ad Pixels5

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains6

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

External Accounts10

Fee markups3

Feedback1

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members5

Memberships13

Messages5

Notifications6

Partner Referral Requests6

Partners11

Payment Method Domains5

Payment methods3

Payment Quotes2

Payment Rules9

Payments14

Payout accounts1

Payout methods2

Payouts11

People2

Permissions1

Plans6

Product Affiliates1

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews3

Setup Intents6

Shipments4

Social Accounts10

Stats6

Support channels3

Swaps4

Team Members5

Topups1

Trades3

Transfers6

Users18

Variants6

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts4

Ad Campaigns2

Ad Groups1

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships3

Messages1

Payments7

Payout accounts1

Payouts4

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Variants3

Verifications2

Accounts

List Accounts

Changed on Oct 14, 2026

Lists accounts visible to the credential. User tokens return the user's business accounts; Account API keys return the requesting account and its connected accounts.

get/accounts

Request

Base URL: https://api.whop.com/api/v1
URL: https://api.whop.com/api/v1/accounts
Auth: one of:
- HTTP bearer
- HTTP bearer

Query parameters

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.

order'created_at' | 'volume'

The field to sort accounts by. volume requires stats:read on the parent account.

direction'asc' | 'desc'

Sort direction.

status'active' | 'suspended'

Return only accounts with this status: active (includes accounts that have not entered payments review) or suspended.

querystring

Free-text filter on account title or ID. % and _ match literally.

created_afterstring date-time

Return only accounts created after this ISO 8601 timestamp.

created_beforestring date-time

Return only accounts created before this ISO 8601 timestamp.

volume_minnumber

Return only accounts whose lifetime USD volume is at least this value. Requires stats:read on the parent account.

volume_maxnumber

Return only accounts whose lifetime USD volume is at most this value. Requires stats:read on the parent account.

parent_account_idstring

For platforms: the parent account ID whose direct connected accounts to return. Requires payout:account:read on the parent account.

Response

accounts listed

Example response

{
  "data": [
    {
      "balances": [
        {
          "balance": "1500.0",
          "breakdown": {
            "available": "1500.0",
            "in_transit": "0",
            "pending": "0",
            "pending_settlements": [
              {
                "amount": "0.0",
                "date": "2026-01-01"
              }
            ],
            "reserve": "0"
          },
          "icon_url": "https://assets.whop.com/tokens/usdt.png",
          "name": "Tether USD",
          "price_usd": 1,
          "symbol": "USDT",
          "value_usd": "1500.00"
        }
      ],
      "banner_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "business_address": {
        "city": "Austin",
        "country": "US",
        "line1": "4180 Burnet Rd",
        "line2": "Suite 2",
        "postal_code": "78756",
        "state": "TX"
      },
      "business_name": "Shine Time Auto Detailing, LLC",
      "business_type": "software",
      "cancellation_policy": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "capabilities": {
        "accept_bank_payments": "active",
        "accept_bnpl_payments": "inactive",
        "accept_card_payments": "active",
        "bank_deposit": "inactive",
        "card_deposit": "active",
        "card_issuing": "inactive",
        "crypto_deposit": "active",
        "crypto_payout": "inactive",
        "instant_payout": "inactive",
        "run_ads": "active",
        "standard_payout": "inactive",
        "transfer": "inactive"
      },
      "cards": {
        "kind": "individual",
        "status": "approved"
      },
      "collect_vat_id": true,
      "company_formation": {
        "documents": [
          {
            "id": "file_xxxxxxxxxxxxxx",
            "name": "Articles of Organization",
            "type": "articles_of_organization",
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          }
        ],
        "legal_name": "Shine Time Auto Detailing, LLC",
        "signatures": {
          "form8821": {
            "expires_at": "2026-01-01T12:00:00.000Z",
            "status": "pending",
            "url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
          },
          "ss4": {
            "expires_at": "2026-01-01T12:00:00.000Z",
            "status": "pending",
            "url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
          }
        },
        "state_registered": true
      },
      "country": "us",
      "created_at": "2026-01-01T12:00:00.000Z",
      "description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
      "email": "marcus@shinetime.example",
      "eula": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "financing": {
        "application_id": "inrq_xxxxxxxxxxxxxx",
        "status": "awaiting_review"
      },
      "home_preferences": [
        "hide_member_count"
      ],
      "id": "biz_xxxxxxxxxxxxxx",
      "industry_type": "trading",
      "invoice_prefix": "SHINE",
      "level": {
        "boosted": true,
        "current": 1,
        "points": 41000,
        "points_by_source": {
          "cards": 40000,
          "trading": 1000
        },
        "points_to_next": 59000,
        "resets_at": "2026-01-01T12:00:00.000Z"
      },
      "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "metadata": {
        "external_id": "shop_4417",
        "region": "austin"
      },
      "onboarding_type": "seller",
      "opengraph_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "opengraph_image_variant": "black",
      "orchestration_enabled": true,
      "owner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      },
      "parent_account": {
        "fees": {
          "crypto_swap_markup": {
            "fixed_fee_usd": 0,
            "percentage_fee": 3
          },
          "transfer_markup": {
            "fixed_fee_usd": 0,
            "percentage_fee": 0
          }
        },
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "shine-time-holdings",
        "title": "Shine Time Holdings"
      },
      "partner": {
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        }
      },
      "payment_controls": {
        "dispute_alert_auto_refund": {
          "threshold_usd": 500
        },
        "dispute_alert_fee_usd": 29,
        "pending_auto_topup_fee_percentage": 2,
        "reserve": {
          "hold_period_days": 14,
          "percentage": 15
        },
        "resolution_center_auto_refund": {
          "card_threshold_usd": 50,
          "financing_threshold_usd": 25,
          "paypal_threshold_usd": 40
        },
        "restricted_payment_methods": [
          "card_visa"
        ],
        "undated_pending_reason": "pending_information_request",
        "withdrawal_schedule": {
          "frequency": "manual"
        }
      },
      "platform_credits": [
        {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        }
      ],
      "privacy_policy": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "product_tax_code": {
        "id": "ptc_xxxxxxxxxxxxxx",
        "name": "General - Digital Goods",
        "product_type": "digital"
      },
      "recommended_actions": [
        {
          "action": "apply_for_financing",
          "blocked_capabilities": [
            "accept_bnpl_payments"
          ],
          "cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/",
          "cta_label": "Apply",
          "description": "Let customers pay over time with buy now, pay later.",
          "icon_url": "https://whop.com/illustrations/orange/piggy-bank.svg",
          "impact_score": 86,
          "reasoning": "Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu.",
          "status": "optional",
          "title": "Offer financing at checkout"
        }
      ],
      "require_2fa": true,
      "required_actions": [
        {
          "action": "verify_identity",
          "blocked_capabilities": [
            "standard_payout"
          ],
          "cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/",
          "cta_label": "Verify now",
          "description": "Complete verification to withdraw your earnings.",
          "icon_url": "https://whop.com/illustrations/orange/shield.svg",
          "status": "required",
          "title": "Complete your identity verification"
        }
      ],
      "return_policy": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "rewards": [
        {
          "qualification_amount": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "qualification_progress": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "qualification_type": "sales",
          "reward_amount": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "status": "in_progress"
        }
      ],
      "route": "biz_xxxxxxxxxxxxxx",
      "shipping_policy": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "social_links": [
        {
          "id": "social_1",
          "title": "@shinetimedetail",
          "url": "https://instagram.com/shinetimedetail",
          "website": "instagram"
        }
      ],
      "status": "active",
      "status_reason": "Suspended - Fraudulent activity",
      "store_page_config": {
        "accent_color": "red",
        "layout": "compact",
        "profile_variant": "business",
        "whop_affiliate_link": true
      },
      "target_audience": "Owners of new and enthusiast vehicles in Austin, TX",
      "tax_collection_enabled_states": [
        "TX"
      ],
      "tax_identifiers": [
        {
          "id": "txid_xxxxxxxxxxxxxx",
          "tax_id_type": "eu_vat",
          "tax_id_value": "DE123456789"
        }
      ],
      "tax_remitted_by": "self",
      "tax_type": "inclusive",
      "terms_of_service": {
        "content_type": "application/pdf",
        "created_at": "2026-01-01T12:00:00.000Z",
        "filename": "evidence.pdf",
        "id": "file_xxxxxxxxxxxxxx",
        "multipart_chunk_size": 5242880,
        "multipart_upload_id": "upload-id",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "object": "file",
        "size": 9670,
        "upload_headers": {},
        "upload_status": "pending",
        "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "private"
      },
      "three_ds_level": "mandate_challenge",
      "title": "Shine Time Auto Detailing",
      "total_usd": "50.00",
      "trading": {
        "hyperliquid": {
          "websocket_subscriptions": [
            {
              "channel": "clearinghouse_state"
            }
          ]
        },
        "object": "trading_account",
        "provider": "hyperliquid"
      },
      "use_logo_as_opengraph_image_fallback": true,
      "verification": {
        "business": null,
        "individual": null
      },
      "wallet": {
        "address": "0xabc123",
        "id": "cwal_xxxxxxxxxxxxxx",
        "network": "ethereum"
      },
      "website": "https://shinetimedetail.com"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Oct 14, 20260845dd4950f9 Revision changes
- info
  the security scope company:balance:read was removed from the endpoint's security scheme bearerAuth
Oct 14, 2026507636677fe9 Revision changes
- breaking
  removed the required property // from the response with the status
- warning
  added the new acss_debit enum value to the //////// response property for the response status
- warning
  added the new addi enum value to the //////// response property for the response status
- warning
  added the new affirm enum value to the //////// response property for the response status
- warning
  added the new afterpay_clearpay enum value to the //////// response property for the response status
- warning
  added the new alma enum value to the //////// response property for the response status
- warning
  added the new amazon_pay enum value to the //////// response property for the response status
- warning
  added the new au_becs_debit enum value to the //////// response property for the response status
- warning
  added the new bacs_debit enum value to the //////// response property for the response status
- warning
  added the new billie enum value to the //////// response property for the response status
- warning
  added the new capchase_pay enum value to the //////// response property for the response status
- warning
  added the new card_installments_six enum value to the //////// response property for the response status
- warning
  added the new card_installments_three enum value to the //////// response property for the response status
- warning
  added the new card_installments_twelve enum value to the //////// response property for the response status
- warning
  added the new cashapp enum value to the //////// response property for the response status
- warning
  added the new claritypay enum value to the //////// response property for the response status
- warning
  added the new flex_pay enum value to the //////// response property for the response status
- warning
  added the new klarna enum value to the //////// response property for the response status
- warning
  added the new klarna_pay_now enum value to the //////// response property for the response status
- warning
  added the new kriya enum value to the //////// response property for the response status
- warning
  added the new kueski enum value to the //////// response property for the response status
- warning
  added the new link enum value to the //////// response property for the response status
- warning
  added the new mondu enum value to the //////// response property for the response status
- warning
  added the new oney enum value to the //////// response property for the response status
- warning
  added the new oney_3x enum value to the //////// response property for the response status
- warning
  added the new oney_4x enum value to the //////// response property for the response status
- warning
  added the new pay_by_bank enum value to the //////// response property for the response status
- warning
  added the new paypal enum value to the //////// response property for the response status
- warning
  added the new payto enum value to the //////// response property for the response status
- warning
  added the new scalapay enum value to the //////// response property for the response status
- warning
  added the new sepa_debit enum value to the //////// response property for the response status
- warning
  added the new sequra enum value to the //////// response property for the response status
- warning
  added the new sezzle enum value to the //////// response property for the response status
- warning
  added the new splitit enum value to the //////// response property for the response status
- warning
  added the new sunbit enum value to the //////// response property for the response status
- warning
  added the new tabby enum value to the //////// response property for the response status
- warning
  added the new tamara enum value to the //////// response property for the response status
- warning
  added the new us_bank_account enum value to the //////// response property for the response status
- warning
  added the new venmo enum value to the //////// response property for the response status
- warning
  added the new zip enum value to the //////// response property for the response status
- info
  the security scope company:balance:read was removed from the endpoint's security scheme bearerAuth
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status

Operation history (90 revisions)