Users

Retrieve

Changed on

Retrieves the authenticated user's settings document.

get/users/me/preferences

Request

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

Response

preferences retrieved

bounty_worker_onboarding_dismissedboolean required

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

cards_auto_top_upboolean 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.

investigation_enabledboolean required

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

terms_acceptedboolean required

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

terms_accepted_atstring nullable required

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

Example response

{
  "investigation_enabled": true,
  "terms_accepted": true,
  "terms_accepted_at": "2026-01-01T12:00:00.000Z"
}

Changes

  • 7d2eaa643369Revision changes
    • info

      added the required property to the response with the status

  • 6a23760847c8Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status