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

# List user alert preferences

> Retrieves all alert preferences for the authenticated user, including settings for docket filings and case creation notifications. Returns each preference with its current value, type, title, and description.



## OpenAPI

````yaml api-reference/alerts.yaml post /preferences/list
openapi: 3.0.3
info:
  title: alerts
  description: >-
    The Alerts service listens for important events happening across the
    platform. When something notable occurs, it sends the right notification,
    such as an email or push message, based on each user's preferences.
  version: 1.0.0
servers:
  - url: https://alerts.platform.arb.inc
security: []
tags:
  - name: /
  - name: preferences
  - name: register
paths:
  /preferences/list:
    post:
      tags:
        - preferences
      summary: List user alert preferences
      description: >-
        Retrieves all alert preferences for the authenticated user, including
        settings for docket filings and case creation notifications. Returns
        each preference with its current value, type, title, and description.
      operationId: listPreferences
      responses:
        '200':
          description: Successfully retrieved user preferences
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier for the preference
                      example: docket_filings
                    title:
                      type: string
                      description: Human-readable title for the preference
                      example: Docket Filings
                    description:
                      type: string
                      description: Detailed description of what this preference controls
                      example: Whether to receive alerts when new docket filings occur
                    type:
                      type: string
                      description: Data type of the preference value
                      enum:
                        - boolean
                        - string
                        - number
                      example: boolean
                    value:
                      type: string
                      description: Current value of the preference as a string
                      example: 'true'
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: access token
      scheme: bearer
      bearerFormat: JWT

````