v8

OpenAPI 3.1.02026-08-033623795.0 MB

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.

get/accounts

Query parameters

firstinteger

The number of accounts to return (default 10, max 50).

afterstring

A cursor; returns accounts after this position.

lastinteger

The number of accounts to return from the end of the range.

beforestring

A cursor; returns accounts before this position.

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": [
    {
      "business_type": "education_program",
      "capabilities": {
        "accept_bank_payments": "active",
        "accept_bnpl_payments": "active",
        "accept_card_payments": "active",
        "bank_deposit": "active",
        "card_deposit": "active",
        "card_issuing": "active",
        "crypto_deposit": "active",
        "crypto_payout": "active",
        "instant_payout": "active",
        "run_ads": "active",
        "standard_payout": "active",
        "transfer": "active"
      },
      "cards": {
        "kind": "individual",
        "status": "approved"
      },
      "company_formation": {
        "signatures": {
          "form8821": {
            "status": "pending"
          },
          "ss4": {
            "status": "pending"
          }
        }
      },
      "home_preferences": [
        "hide_member_count"
      ],
      "industry_group": "academic_and_test_prep",
      "industry_type": "trading",
      "onboarding_type": "platform",
      "opengraph_image_variant": "white",
      "payment_controls": {
        "restricted_payment_methods": [
          "card_visa"
        ]
      },
      "recommended_actions": [
        {
          "action": "theme_business",
          "status": "optional"
        }
      ],
      "required_actions": [
        {
          "action": "deposit_funds",
          "status": "required"
        }
      ],
      "social_links": [
        {
          "website": "x"
        }
      ],
      "store_page_config": {
        "accent_color": "ruby",
        "layout": "featured",
        "profile_variant": "personal"
      },
      "tax_identifiers": [
        {
          "tax_id_type": "ad_nrt"
        }
      ],
      "tax_remitted_by": "whop",
      "tax_type": "inclusive",
      "wallet": {
        "network": "solana"
      }
    }
  ]
}