Users

List Users

Changed on

Searches for users by name or username, ranked by social proximity to the authenticated user. Without a query, returns the user's most recently followed users.

get/users

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/users
  • Auth: HTTP bearer

Query parameters

querystring

A search term to filter users by name or username.

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

users listed

Example response

{
  "data": [
    {
      "balance": {
        "businesses": [
          {
            "balance_usd": "18940.25",
            "id": "biz_xxxxxxxxxxxxxx",
            "logo_url": "https://assets.whop.com/logos/shine-time-auto-detailing.png",
            "name": "Shine Time Auto Detailing"
          }
        ],
        "businesses_total_usd": "18940.25",
        "cash": [
          {
            "balance": 4385.75,
            "balance_usd": 4385.75,
            "currency": "usd",
            "pending_balance_usd": 310,
            "reserve_balance_usd": 125,
            "total_withdrawable_balance": 4385.75
          }
        ],
        "cash_usd": "4820.75",
        "crypto": [
          {
            "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
          }
        ],
        "crypto_usd": "1500.00",
        "pending_usd": "310.00",
        "total_usd": "6320.75",
        "treasury_pending_usd": "0.00"
      },
      "balance_history": {
        "data": [
          {
            "t": 1767268800,
            "v": 2400
          }
        ],
        "last": 6320.75,
        "max": 6320.75,
        "min": 2400
      },
      "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": {
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      },
      "bio": "Ceramic coating specialist. Detailing cars in Austin since 2016.",
      "cards": {
        "kind": "individual",
        "status": "approved"
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "earnings_usd": {
        "first_earned_at": "2026-01-01T12:00:00.000Z",
        "owned_accounts": {
          "last_24_hours": "0.00",
          "last_30_days": "260.00",
          "last_7_days": "60.00",
          "lifetime": "4120.25"
        },
        "partners": {
          "last_24_hours": "0.00",
          "last_30_days": "260.00",
          "last_7_days": "60.00",
          "lifetime": "4120.25"
        },
        "personal": {
          "last_24_hours": "0.00",
          "last_30_days": "260.00",
          "last_7_days": "60.00",
          "lifetime": "4120.25"
        },
        "total": {
          "last_24_hours": "0.00",
          "last_30_days": "260.00",
          "last_7_days": "60.00",
          "lifetime": "4120.25"
        }
      },
      "email": "marcus@shinetime.example",
      "id": "user_xxxxxxxxxxxxxx",
      "level": {
        "current": 1,
        "points": 41000,
        "points_by_source": {
          "cards": 40000,
          "trading": 1000
        },
        "points_to_next": 59000,
        "resets_at": "2026-01-01T12:00:00.000Z"
      },
      "name": "Marcus Webb",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "social_links": [
        {
          "url": "https://www.instagram.com/tanyacole.details",
          "username": "tanyacole.details",
          "verified": true,
          "website": "instagram"
        }
      ],
      "total_usd": "6320.75",
      "trading": {
        "hyperliquid": {
          "websocket_subscriptions": [
            {
              "channel": "clearinghouse_state"
            }
          ]
        },
        "object": "trading_account",
        "provider": "hyperliquid"
      },
      "username": "marcuswebb",
      "verification": {
        "business": null,
        "individual": null
      },
      "whop_partner_enabled_at": "2026-01-01T12:00:00.000Z",
      "whop_partner_onboarded_accounts_count": 1,
      "whop_partner_verified_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "MQ"
  }
}

Changes

  • 507636677fe9Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • c3b5561c6176Revision changes
    • breaking

      removed the required property // from the response with the status