Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Response

preferences retrieved

bounty_worker_onboarding_dismissed
boolean
required

Whether the user has dismissed the first-time bounty worker onboarding. Set to false to show it again.

Example:

false

cards_auto_top_up
boolean
required

Whether incoming funds, including pending balance, are automatically moved to the user's personal cards balance. false when the user has no cards balance.

Example:

false

investigation_enabled
boolean
required

Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access.

Example:

true

terms_accepted
boolean
required

Whether the user has accepted Whop's terms and policies. false until recorded via PATCH with terms_accepted: true.

Example:

true

terms_accepted_at
string | null
required

When the user most recently accepted Whop's terms and policies, as an ISO 8601 timestamp. null until accepted.

Example:

"2026-01-01T12:00:00.000Z"