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

# List notifications



## OpenAPI

````yaml /openapi/customer-api.json get /notifications/feed
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /notifications/feed:
    get:
      tags:
        - Notifications
      operationId: NotificationsController_getFeed
      parameters:
        - description: 1-based page number (default 1)
          in: query
          name: page
          required: false
          schema:
            type: string
        - description: Page size (1-100, default 20)
          in: query
          name: limit
          required: false
          schema:
            type: string
        - description: >-
            Project scope (REQUIRED). The feed is always mounted under a
            project, so it must be scoped to one — the @CustomerApi guard then
            authorises the caller against this project. An omitted scope must
            NOT fall back to an all-projects read: that would return historical
            rows (incl. EntityChanged structured diffs) from projects the caller
            has since lost access to.
          in: query
          name: project_id
          required: true
          schema:
            type: string
        - description: 'Branch filter: ''master'' for Base, a branch UUID, or omit for all'
          in: query
          name: branch_id
          required: false
          schema:
            type: string
        - description: When "true", only unread notifications
          in: query
          name: unread
          required: false
          schema:
            type: string
        - description: >-
            Type filter category: 'item' (entity updates), 'comments', 'reviews'
            (branch review lifecycle), or omit/'all' for every type
          in: query
          name: type
          required: false
          schema:
            type: string
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationFeedPageDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    NotificationFeedPageDto:
      properties:
        items:
          items:
            $ref: '#/components/schemas/NotificationFeedItemDto'
          type: array
        total:
          description: Total matching rows across all pages
          type: number
      required:
        - items
        - total
      type: object
    NotificationFeedItemDto:
      properties:
        created_at:
          type: string
        event_type:
          enum:
            - UserInvited
            - ReviewAssigned
            - ReviewSubmitted
            - ReviewStale
            - RequirementBroken
            - CommentMention
            - EntityChanged
            - CommentReply
            - CommentResolved
            - BranchReadyForReview
            - BranchMerged
            - BranchOwnerChanged
            - ShareViewOpened
          type: string
        id:
          type: string
        payload:
          additionalProperties: true
          type: object
        read:
          type: boolean
      required:
        - id
        - event_type
        - payload
        - created_at
        - read
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````