Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Users

List Users

Search for users by name or username, ranked by social proximity to the authenticated user. Returns the user's most recently followed users when no query is given.

get/users

Query parameters

querystring

A search term to filter users by name or username.

firstinteger

The number of users to return (max 50).

afterstring

A cursor; returns users after this position.

lastinteger

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

beforestring

A cursor; returns users before this position.

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": "0.00",
        "crypto": [
          {
            "balance": "1500.0",
            "icon_url": "https://assets.whop.com/tokens/usdt.png",
            "name": "Tether USD",
            "price_usd": 1,
            "symbol": "USDT",
            "value_usd": 1500
          }
        ],
        "crypto_usd": "0.00",
        "pending_usd": "0.00",
        "total_usd": "0.00",
        "treasury_pending_usd": "0.00"
      },
      "balance_history": {
        "data": [
          {
            "t": 1767225600,
            "v": 2400
          }
        ]
      },
      "banner": {
        "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      },
      "bio": "Ceramic coating specialist. Detailing cars in Austin since 2016.",
      "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"
        },
        "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",
      "name": "Marcus Webb",
      "profile_picture": {
        "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      },
      "social_accounts": [
        {
          "error": "You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again.",
          "external_id": "1234567891",
          "id": "sacc_xxxxxxxxxxxxxx",
          "name": "Shine Time Auto Detailing",
          "parent_social_account": {
            "external_id": "555111",
            "id": "sacc_xxxxxxxxxxxxxx",
            "name": "Shine Time Auto Detailing",
            "platform": "facebook",
            "profile_picture_url": "https://shinetime.example/logo.png",
            "username": "shinetimedetailing",
            "verified": true
          },
          "platform": "instagram",
          "profile_picture_url": "https://shinetime.example/logo.png",
          "scopes": [
            "advertise"
          ],
          "url": "https://instagram.com/shinetimedetail",
          "username": "shinetimedetail",
          "verified": true
        }
      ],
      "staff": {
        "admin": true,
        "investigation_access": true
      },
      "username": "marcuswebb",
      "verification": {
        "business": null,
        "individual": null
      },
      "whop_partner_enabled_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "end_cursor": "MQ",
    "start_cursor": "MQ"
  }
}