Users

Retrieve

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

get/users/me/preferences

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.

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

Changed in 5 of the 74 revisions of this API.6

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the security scope user:profile:update was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.