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

# List notifications

> Returns paginated notifications for the authenticated user. By default returns active (non-archived, non-dismissed) notifications ordered by created_at descending.




## OpenAPI

````yaml /openapi/notifications.yaml get /notifications
openapi: 3.1.0
info:
  title: Connie Notifications API
  version: 1.0.0
  description: >
    API for managing in-app notifications. All endpoints require authentication.
    Notifications are created internally via the dispatcher system and surfaced
    to users through bell (in-app), email, or toast channels.
servers:
  - url: https://connie.ai/api
    description: Production
security:
  - cookieAuth: []
tags:
  - name: Notifications
    description: Read, dismiss, and manage user notifications
paths:
  /notifications:
    get:
      tags:
        - Notifications
      summary: List notifications
      description: >
        Returns paginated notifications for the authenticated user. By default
        returns active (non-archived, non-dismissed) notifications ordered by
        created_at descending.
      operationId: listNotifications
      parameters:
        - name: workspace_id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter notifications by workspace
        - name: unread_only
          in: query
          schema:
            type: boolean
            default: false
          description: Return only unread notifications
        - name: include_dismissed
          in: query
          schema:
            type: boolean
            default: false
          description: Include dismissed notifications in results
        - name: include_archived
          in: query
          schema:
            type: boolean
            default: false
          description: Include archived notifications (full history)
        - name: only_archived
          in: query
          schema:
            type: boolean
            default: false
          description: Return only archived notifications
        - name: priority
          in: query
          schema:
            type: string
            enum:
              - low
              - normal
              - high
              - urgent
          description: Filter by priority level
        - name: related_type
          in: query
          schema:
            type: string
            enum:
              - reminder
              - task
              - conversation
              - workflow
              - contact
              - company
              - deal
              - invite
              - message
          description: Filter by related entity type
        - name: related_id
          in: query
          schema:
            type: string
          description: Filter by related entity ID
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
          description: Number of notifications to return
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Pagination offset
      responses:
        '200':
          description: Notifications list
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
                  count:
                    type: integer
                    description: Total count matching filters
                  unread_count:
                    type: integer
                    description: Total unread count
                  archived_count:
                    type: integer
                    description: Total archived count
                  limit:
                    type: integer
                  offset:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Notification:
      type: object
      properties:
        id:
          type: string
          format: uuid
        user_id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        read:
          type: boolean
        read_at:
          type: string
          format: date-time
          nullable: true
        is_dismissed:
          type: boolean
        archived_at:
          type: string
          format: date-time
          nullable: true
        category:
          type: string
          description: Notification category (maps to user preference)
          example: workflow_failures
        priority:
          type: string
          enum:
            - low
            - normal
            - high
            - urgent
        type:
          type: string
          description: Specific event key
          example: INBOX_EMAIL_SEND_FAILED
        title:
          type: string
        message:
          type: string
        link:
          type: string
          nullable: true
          description: CTA link (HTTPS URL or relative path)
        related_type:
          type: string
          nullable: true
          enum:
            - reminder
            - task
            - conversation
            - workflow
            - contact
            - company
            - deal
            - invite
            - message
        related_id:
          type: string
          nullable: true
        metadata:
          type: object
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: session

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.