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

# List notifications

> Retrieve paginated list of notifications for the authenticated user



## OpenAPI

````yaml /swagger.json get /v1/apps/{app_id}/notifications
openapi: 3.0.1
info:
  title: Scute API
  version: v1
  description: API for managing users in Scute applications
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.scute.io
  - url: http://localhost:3333
    description: Development server
security:
  - apiSecret: []
    userAccess: []
paths:
  /v1/apps/{app_id}/notifications:
    parameters:
      - name: app_id
        in: path
        required: true
        description: App ID
        schema:
          type: string
    get:
      tags:
        - Notifications
      summary: List notifications
      description: Retrieve paginated list of notifications for the authenticated user
      operationId: listNotifications
      parameters:
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Items per page (default: 20)'
          schema:
            type: integer
        - name: category
          in: query
          required: false
          description: Filter by category (e.g., security, verification, workspace)
          schema:
            type: string
        - name: unread
          in: query
          required: false
          description: Filter unread only (set to 'true')
          schema:
            type: string
        - name: requires_action
          in: query
          required: false
          description: Filter notifications requiring action (set to 'true')
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                      unread_count:
                        type: integer
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
      security:
        - apiSecret: []
          userAccess: []
components:
  schemas:
    Notification:
      type: object
      properties:
        id:
          type: string
          description: Notification ID
        app_id:
          type: string
          description: Application ID
        app_user_id:
          type: string
          description: App user ID
        event_type:
          type: string
          description: Event type that triggered this notification
          example: verification.otp.sent
        category:
          type: string
          description: Notification category
          example: verification
        priority:
          type: string
          enum:
            - low
            - medium
            - high
            - critical
          description: Notification priority
        status:
          type: string
          enum:
            - pending
            - sent
            - delivered
            - failed
            - read
          description: Delivery status
        title:
          type: string
          description: Notification title
          example: Verification Code Sent
        body:
          type: string
          description: Notification body text
        action_url:
          type: string
          nullable: true
          description: URL for notification action
        action_text:
          type: string
          nullable: true
          description: Text for action button
        requires_action:
          type: boolean
          description: Whether user action is required
        dismissible:
          type: boolean
          description: Whether notification can be dismissed
        read:
          type: boolean
          description: Whether notification has been read
        read_at:
          type: string
          format: date-time
          nullable: true
        dismissed:
          type: boolean
          description: Whether notification has been dismissed
        dismissed_at:
          type: string
          format: date-time
          nullable: true
        expired:
          type: boolean
          description: Whether notification has expired
        expires_at:
          type: string
          format: date-time
          nullable: true
        metadata:
          type: object
          description: Additional notification metadata
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - app_id
        - event_type
        - category
        - priority
        - status
        - title
        - body
  securitySchemes:
    apiSecret:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: API Secret token
    userAccess:
      type: apiKey
      name: X-Authorization
      in: header
      description: User Access token

````