Skip to main content
GET
/
accounts
List Accounts
curl --request GET \
  --url https://{defaultHost}/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "title": "<string>",
      "description": "<string>",
      "route": "<string>",
      "logo_url": "<string>",
      "banner_image_url": "<string>",
      "business_type": "<string>",
      "country": "<string>",
      "home_preferences": [
        "<string>"
      ],
      "industry_group": "<string>",
      "industry_type": "<string>",
      "invoice_prefix": "<string>",
      "onboarding_type": "<string>",
      "opengraph_image_url": "<string>",
      "opengraph_image_variant": "<string>",
      "other_business_description": "<string>",
      "other_industry_description": "<string>",
      "require_2fa": true,
      "target_audience": "<string>",
      "send_customer_emails": true,
      "show_joined_whops": true,
      "show_reviews_dtc": true,
      "show_user_directory": true,
      "store_page_config": {},
      "parent_account_id": "<string>",
      "metadata": {},
      "created_at": "<string>",
      "use_logo_as_opengraph_image_fallback": true,
      "total_earned_usd": 123,
      "status": "<string>",
      "capabilities": {
        "accept_card_payments": "active",
        "accept_bank_payments": "active",
        "accept_bnpl_payments": "active",
        "standard_payout": "active",
        "instant_payout": "active",
        "crypto_payout": "active",
        "transfer": "active",
        "bank_deposit": "active",
        "crypto_deposit": "active",
        "card_deposit": "active",
        "card_issuing": "active"
      },
      "required_actions": [
        {
          "action": "deposit_funds",
          "status": "required",
          "title": "<string>",
          "description": "<string>",
          "cta_label": "<string>",
          "cta": "<string>",
          "icon_url": "<string>",
          "blocked_capabilities": [
            "<string>"
          ]
        }
      ],
      "recommended_actions": [
        {
          "action": "apply_for_financing",
          "status": "optional",
          "title": "<string>",
          "description": "<string>",
          "cta_label": "<string>",
          "cta": "<string>",
          "icon_url": "<string>",
          "blocked_capabilities": [
            "<string>"
          ]
        }
      ],
      "tax_remitted_by": "<string>",
      "product_tax_code": {},
      "business_address": {},
      "tax_identifiers": "<array>",
      "total_usd": "<string>",
      "balances": [
        {
          "symbol": "<string>",
          "name": "<string>",
          "balance": "<string>",
          "value_usd": "<string>",
          "price_usd": 123,
          "icon_url": "<string>",
          "breakdown": {}
        }
      ],
      "verification": {},
      "wallet": {
        "id": "<string>",
        "address": "<string>",
        "network": "solana"
      },
      "social_links": [
        {
          "id": "<string>",
          "website": "x",
          "url": "<string>",
          "title": "<string>"
        }
      ]
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Query Parameters

first
integer

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

after
string

A cursor; returns accounts after this position.

last
integer

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

before
string

A cursor; returns accounts before this position.

order
enum<string>
default:created_at

The field to sort accounts by.

Available options:
created_at
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

accounts listed

data
object[]
required
page_info
object
required