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

# List Notifications

> List all notifications for the user's organization.



## OpenAPI

````yaml post /v1/notifications/list
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/notifications/list:
    post:
      tags:
        - Notifications
      summary: List Notifications
      description: List all notifications for the user's organization.
      operationId: list_notifications_v1_notifications_list_post
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - maximum: 1000
                minimum: 1
                type: integer
              - type: 'null'
            title: Limit
        - name: page_size
          in: query
          required: false
          schema:
            anyOf:
              - maximum: 1000
                minimum: 1
                type: integer
              - type: 'null'
            title: Page Size
        - name: offset
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 10000
                minimum: 0
              - type: 'null'
            title: Offset
        - name: page
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 1
              - type: 'null'
            title: Page
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: include_total
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Total
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNotificationsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotificationsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListNotificationsRequest:
      properties:
        notification_type:
          anyOf:
            - $ref: '#/components/schemas/NotificationType'
            - type: 'null'
          description: Filter by notification type
        priority:
          anyOf:
            - $ref: '#/components/schemas/NotificationPriority'
            - type: 'null'
          description: Filter by priority
        read:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Read
          description: Filter by read status
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
          description: Filter by user ID
      type: object
      title: ListNotificationsRequest
      description: Request model for listing notifications.
    ListNotificationsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/Notification'
          type: array
          title: Results
          description: List of notifications
        pagination:
          additionalProperties: true
          type: object
          title: Pagination
          description: Pagination information
        total:
          type: integer
          title: Total
          description: Total number of notifications
      type: object
      required:
        - results
        - pagination
        - total
      title: ListNotificationsResponse
      description: Response model for listing notifications.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NotificationType:
      type: string
      enum:
        - pipeline_success
        - pipeline_failure
        - feature_extraction_success
        - feature_extraction_failure
        - system_alert
        - billing_alert
        - quota_alert
        - audit_alert
        - maintenance_alert
        - custom
        - onboarding_nudge
        - engagement_nudge
        - feature_tip
      title: NotificationType
      description: Enum for notification types.
    NotificationPriority:
      type: string
      enum:
        - low
        - medium
        - high
        - critical
      title: NotificationPriority
      description: Enum for notification priority levels.
    Notification:
      properties:
        id:
          type: string
          title: Id
          description: Unique ID
        type:
          $ref: '#/components/schemas/NotificationType'
          description: Notification type
        priority:
          $ref: '#/components/schemas/NotificationPriority'
          description: Priority level
        title:
          type: string
          title: Title
          description: Notification title
        content:
          type: string
          title: Content
          description: Notification content
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        organization_id:
          type: string
          title: Organization Id
          description: Organization ID
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
          description: User ID (if applicable)
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Additional metadata
        delivery_status:
          additionalProperties:
            type: string
          propertyNames:
            $ref: '#/components/schemas/NotificationChannel'
          type: object
          title: Delivery Status
          description: Delivery status by channel
        read:
          type: boolean
          title: Read
          description: Whether the notification has been read
          default: false
        read_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Read At
          description: When the notification was read
      type: object
      required:
        - type
        - priority
        - title
        - content
        - organization_id
      title: Notification
      description: Model for a notification instance.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````