Retrieve

Retrieves the authenticated user’s settings document. Addressed only as me — the document always belongs to the session user.

GET /users/me/preferences

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const preference = await client.users.preferences.retrieve();

console.log(preference.bounty_worker_onboarding_dismissed);

200

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

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Response

200

application/json

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

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"