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

# List insights

> Returns all visible (active and read) insights for the authenticated user's family, ordered by priority then recency. Requires preview features to be enabled for the user.




## OpenAPI

````yaml /openapi.yaml get /api/v1/insights
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation generated from executable request specs.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/insights:
    get:
      tags:
        - Insights
      summary: List insights
      description: >
        Returns all visible (active and read) insights for the authenticated
        user's family, ordered by priority then recency. Requires preview
        features to be enabled for the user.
      responses:
        '200':
          description: insights retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightCollection'
        '403':
          description: preview features not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
        - bearerAuth: []
components:
  schemas:
    InsightCollection:
      type: object
      required:
        - insights
      properties:
        insights:
          type: array
          items:
            $ref: '#/components/schemas/Insight'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
          nullable: true
        details:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Validation error messages (alternative to details used by trades,
            valuations, etc.)
    Insight:
      type: object
      required:
        - id
        - type
        - title
        - body
        - priority
        - status
        - generated_at
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - spending_anomaly
            - cash_flow_warning
            - net_worth_milestone
            - subscription_audit
            - savings_rate_change
            - idle_cash
            - budget_at_risk
            - budget_on_track
          description: The insight type that describes the financial observation.
        title:
          type: string
          description: Short summary of the insight.
        body:
          type: string
          description: >-
            Full prose explanation of the insight, written by the LLM from
            pre-computed numbers.
        priority:
          type: string
          enum:
            - high
            - medium
            - low
        status:
          type: string
          enum:
            - active
            - read
            - acknowledged
            - expired
          description: >
            User-facing status of the insight. `active` and `read` are visible
            in the feed; `acknowledged` means the user dismissed it; `expired`
            means the underlying condition cleared.
        generated_at:
          type: string
          format: date-time
          nullable: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OAuth2 Bearer token. Obtain a token from the /api/v1/auth/login or
        /api/v1/auth/refresh endpoints. The token must have the 'read' or
        'read_write' scope.

````