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

# List notifications

> Returns paginated list of notifications with optional filters.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/notifications
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/notifications:
    get:
      tags:
        - Notifications
      summary: List notifications
      description: Returns paginated list of notifications with optional filters.
      parameters:
        - schema:
            type: string
            format: uuid
          required: false
          name: userId
          in: query
        - schema:
            type: string
          required: false
          name: status
          in: query
        - schema:
            type: string
          required: false
          name: type
          in: query
        - schema:
            type: string
          required: false
          name: category
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        user_id:
                          type: string
                          nullable: true
                          format: uuid
                        type:
                          type: string
                        title:
                          type: string
                        body:
                          type: string
                          nullable: true
                        status:
                          type: string
                        category:
                          type: string
                          nullable: true
                        priority:
                          type: string
                          nullable: true
                        data:
                          nullable: true
                        created_at:
                          type: string
                        read_at:
                          type: string
                          nullable: true
                        dismissed_at:
                          type: string
                          nullable: true
                      required:
                        - id
                        - user_id
                        - type
                        - title
                        - body
                        - status
                        - category
                        - priority
                        - created_at
                        - read_at
                        - dismissed_at
                  total:
                    type: number
                  limit:
                    type: number
                  offset:
                    type: number
                required:
                  - notifications
                  - total
                  - limit
                  - offset

````