Accounts
List Accounts
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. Pass parent_account_id to return only that parent account's connected accounts. Includes each account's cards application summary when the caller has company:balance:read access to that account.
get/accounts
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": "50.0",
"breakdown": {
"available": "1500.0",
"in_transit": "0",
"pending": "0",
"pending_settlements": [
{
"amount": "12.5",
"date": "2026-01-01"
}
],
"reserve": "0"
},
"icon_url": "https://assets.whop.com/tokens/usd.png",
"name": "US Dollar",
"price_usd": 1,
"symbol": "USD",
"value_usd": "50.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": "other",
"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"
},
"home_preferences": [
"hide_member_count"
],
"id": "biz_xxxxxxxxxxxxxx",
"industry_group": "automotive",
"industry_type": "other",
"invoice_prefix": "SHINE",
"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,
"other_business_description": "Mobile auto detailing",
"other_industry_description": "Automotive services",
"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"
}
},
"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": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_progress": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_type": "sales",
"reward_amount": {
"amount": "-2.50",
"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 payment 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": {
"margin_summary": {
"account_value": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"total_margin_used": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"total_position_notional": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"total_raw_usd": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"withdrawable": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
},
"websocket_subscriptions": [
{
"channel": "clearinghouse_state"
}
]
},
"object": "trading_account",
"open_orders": [
{
"hyperliquid": {
"trigger_price": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
},
"object": "trading_order",
"order_type": "limit",
"price": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"side": "buy",
"status": "open",
"time_in_force": "add_liquidity_only"
}
],
"positions": [
{
"entry_price": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"hyperliquid": {
"cumulative_funding": {
"all_time": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"since_change": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"since_open": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
},
"leverage": {
"type": "cross"
},
"liquidation_price": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"margin_used": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
},
"object": "trading_position",
"position_value": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"side": "long",
"unrealized_pnl": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
}
],
"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"
}
}