GET /v1/user-prefs
The authenticated user's UI preferences. With no saved view mode, `view_mode` is the plan default (paid → advanced, free → essentials) and `view_mode_saved` is false. `onboarding` is present ONLY for an account that has an onboarding record (accounts created after the onboarding rebuild); its absence means the onboarding is never shown. `lab_invite` is about the AI Lab invite (the ask bar): null = it may be shown; { state: closed | clicked | expired | opened, at } = it is not shown again (`opened` with a null instant: the account has used the AI Lab); the key is absent while a close cannot be remembered.
The authenticated user's UI preferences. With no saved view mode, view_mode is the plan default (paid → advanced, free → essentials) and view_mode_saved is false. onboarding is present ONLY for an account that has an onboarding record (accounts created after the onboarding rebuild); its absence means the onboarding is never shown. lab_invite is about the AI Lab invite (the ask bar): null = it may be shown; { state: closed | clicked | expired | opened, at } = it is not shown again (opened with a null instant: the account has used the AI Lab); the key is absent while a close cannot be remembered.
API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/user-prefs"{ "view_mode": "essentials", "view_mode_saved": true, "default_view_mode": "essentials", "onboarding": { "state": "pending", "step": 0, "answers": { "styles": [ "string" ], "topics": [ "string" ] }, "checklist_closed": true, "first_run_seen_at": "2019-08-24T14:15:22Z", "start_closed": true }, "lab_invite": { "state": "closed", "at": "string" }}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "running": 0, "limit": 0, "issues": [ null ], "trace_id": "string"}