> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dacard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get user preferences

> Retrieve the authenticated user's UI and notification preferences.
Returns a JSON object with namespaced keys (e.g. `appearance`, `privacy`).




## OpenAPI

````yaml get /api/preferences
openapi: 3.1.0
info:
  title: Dacard.ai API
  description: >
    Decision intelligence platform for AI-native product teams.

    Score, connect, and compound your product maturity across two original
    frameworks.
  version: 0.1.0
  contact:
    name: Darren Card
    email: darren@darrencard.com
    url: https://darrencard.com
  license:
    name: Proprietary
servers:
  - url: https://app.dacard.ai
    description: Production
  - url: http://localhost:3001
    description: Local development
security: []
tags:
  - name: Scoring
    description: AI maturity scoring engine
  - name: Lifecycle
    description: Development Lifecycle assessment
  - name: Products
    description: Product management and analytics
  - name: Dashboard
    description: Dashboard and suite analytics
  - name: Account
    description: Account and team management
  - name: Billing
    description: Stripe billing integration
  - name: User
    description: User profile, onboarding, and preferences
  - name: System
    description: Health checks and diagnostics
  - name: Internal
    description: Internal and admin endpoints (PQL tracking, demo data management)
  - name: Agents
    description: Agent Studio - autonomous AI agents, triggers, and artifacts
  - name: Intelligence
    description: Alerts, coaching context, and score timeline
  - name: Anomalies
    description: Signal anomaly detection, acknowledgment, and sensitivity overrides
  - name: Outcomes
    description: Longitudinal outcome observations for validation study (E2.2)
  - name: Settings
    description: User and account notification preferences
  - name: Webhooks
    description: Outbound webhook management
  - name: API Keys
    description: API key management (Team and Enterprise plans)
paths:
  /api/preferences:
    get:
      tags:
        - User
      summary: Get user preferences
      description: >
        Retrieve the authenticated user's UI and notification preferences.

        Returns a JSON object with namespaced keys (e.g. `appearance`,
        `privacy`).
      operationId: getPreferences
      responses:
        '200':
          description: User preferences object
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Free-form JSON preferences (structure varies by client
                  version)
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - clerkAuth: []
        - bearerAuth: []
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Authentication required
            code: AUTH_REQUIRED
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Machine-readable error message
        code:
          type: string
          description: Error code
          enum:
            - AUTH_REQUIRED
            - FORBIDDEN
            - NOT_FOUND
            - INVALID_URL
            - CRAWL_FAILED
            - SCORE_FAILED
            - QUOTA_EXCEEDED
            - ANON_RATE_LIMIT
            - SIGNAL_RATE_LIMITED
            - SIGNAL_VALIDATION_FAILED
            - SERVER_ERROR
        message:
          type: string
          description: Human-readable message
        details:
          description: Additional context
  securitySchemes:
    clerkAuth:
      type: apiKey
      in: cookie
      name: __session
      description: |
        Clerk session cookie. Authentication is handled by Clerk.
        Sign in at https://app.dacard.ai/sign-in to obtain a session.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        Clerk JWT session token. Obtain via Clerk's frontend SDK
        using `getToken()` or via the Clerk Backend API.

````