Skip to main content
A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience.

​
Endpoints

EndpointRequest
List UsersGET /users
Retrieve UserGET /users/{id}
Update UserPATCH /users/{id}
Check User AccessGET /users/{id}/access/{resource_id}
Update Current UserPATCH /users/me

​
Attributes

​
balances
object[]
required

Properties

​
balance
string
required
The total amount held in native units, as a decimal string
​
breakdown
object
required
The holding split into available, pending, and reserve amounts (native-unit decimal strings). On-chain crypto is entirely available; good_funds and fiat cash can have pending/reserve portions
​
icon_url
string | null
required
The URL of the holding’s icon, when available
​
name
string
required
The holding’s display name
​
price_usd
number | null
required
The USD price per unit, or null when no exchange rate is available
​
symbol
string
required
The holding’s display symbol, e.g. USDT, cbBTC, or EUR
​
value_usd
string | null
required
The total USD value of the holding, or null when no exchange rate is available
​
bio
string | null
required
The user’s biography
​
created_at
string
required
When the user was created, as an ISO 8601 timestamp
​
id
string
required
The ID of the user, which will look like user_*************
​
name
string | null
required
The user’s display name
​
profile_picture
object | null
required
The user’s profile picture, an object with a url
​
total_usd
string | null
required
Total USD value across all balances with a known exchange rate. Only computed on the self-view (GET /users/me) for callers with the balance-read scope; null (with an empty balances array) otherwise and when the balance source is unavailable
​
username
string
required
The user’s unique username
​
verification
object
required
The user’s identity-verification status. individual is KYC, business is KYB; each is null when that profile has not been created, otherwise {status} where status is one of not_started, pending, approved, rejected
User
{
	"balances": [
		{
			"balance": "250.00",
			"breakdown": {
				"available": "250.00",
				"pending": "0",
				"reserve": "0"
			},
			"icon_url": "https://cdn.whop.com/tokens/usdt.png",
			"name": "Tether USD",
			"price_usd": 1,
			"symbol": "USDT",
			"value_usd": "250.00"
		}
	],
	"bio": "Building communities on Whop.",
	"created_at": "2026-06-01T12:00:00Z",
	"id": "user_alex123",
	"name": "Alex Rivera",
	"profile_picture": {
		"url": "https://cdn.whop.com/avatar.png"
	},
	"total_usd": "250.00",
	"username": "alex",
	"verification": {
		"business": null,
		"individual": {
			"status": "approved"
		}
	}
}