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

# List notifications



## OpenAPI

````yaml get /v1/notifications
openapi: 3.0.0
info:
  title: Notification APIs Specification
  description: Section for description
  version: '1.0'
  contact: {}
servers:
  - url: https://staging.api.us.aptlydone.com
  - url: https://staging.api.us.aptlydone.com/notification
  - url: https://api.us.aptlydone.com
  - url: https://api.us.aptlydone.com/notification
security: []
tags: []
paths:
  /v1/notifications:
    get:
      tags:
        - notifications
      summary: List notifications
      operationId: NotificationController_getUserNotifications_v1
      parameters:
        - name: page
          required: true
          in: query
          description: Page number
          schema:
            default: 1
            type: number
        - name: limit
          required: true
          in: query
          description: Number of items per page
          schema:
            default: 10
            type: number
        - name: tenantId
          required: false
          in: query
          description: >-
            Tenant ID to filter notifications (optional, defaults to user active
            tenant)
          schema:
            format: uuid
            example: 123e4567-e89b-12d3-a456-426614174000
            type: string
        - name: status
          required: false
          in: query
          description: Filter by notification status
          schema:
            type: string
            enum:
              - UNREAD
              - READ
        - name: templateKey
          required: false
          in: query
          description: Filter by template key
          schema:
            example: DELEGATION_ISSUED
            type: string
        - name: category
          required: false
          in: query
          description: Filter by category
          schema:
            example: Delegations
            type: string
        - name: entityType
          required: false
          in: query
          description: Filter by entity type
          schema:
            example: delegation
            type: string
        - name: timePeriod
          required: false
          in: query
          description: Filter by time period (1m, 3m, 6m, all)
          schema:
            default: all
            type: string
            enum:
              - 1m
              - 3m
              - 6m
              - all
      responses:
        '200':
          description: Notifications retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationResponseDtoResponse'
      security:
        - accessToken: []
components:
  schemas:
    PaginatedNotificationResponseDtoResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 200
        timestamp:
          type: string
          example: '2026-01-12T09:08:08.311Z'
        message:
          type: string
          example: Success
        data:
          type: object
          required:
            - page
            - limit
            - total
            - data
          properties:
            page:
              type: number
              example: 1
              minimum: 1
            limit:
              type: number
              example: 10
              minimum: 1
            total:
              type: number
              example: 100
              minimum: 0
            data:
              type: array
              items:
                $ref: '#/components/schemas/NotificationResponseDto'
      required:
        - statusCode
        - timestamp
        - message
    NotificationResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The notification ID
          example: 550e8400-e29b-41d4-a716-446655440002
        tenantId:
          type: string
          description: Tenant ID to filter notifications
          example: 123e4567-e89b-12d3-a456-426614174000
        templateKey:
          type: string
          description: The notification template key
          example: DELEGATION_ISSUED
        category:
          type: string
          description: The notification category
          example: Delegations
        title:
          type: string
          description: The notification title
          example: Delegation Issued
        message:
          type: string
          description: The notification message content
          example: Delegation ABC123 was issued to you. Click to review.
        isActionable:
          type: boolean
          description: Whether the notification is actionable
          example: true
        status:
          type: string
          enum:
            - UNREAD
            - READ
          description: The notification status
          example: UNREAD
        createdAt:
          format: date-time
          type: string
          description: Timestamp when the notification was created
          example: '2023-01-01T12:00:00Z'
        readAt:
          format: date-time
          type: string
          nullable: true
          description: Timestamp when the notification was read, if applicable
          example: '2023-01-02T14:30:00Z'
        userId:
          type: string
          description: The user ID who received this notification
          example: 550e8400-e29b-41d4-a716-446655440000
        entityType:
          type: string
          description: The type of entity this notification relates to
          example: delegation
        entityId:
          type: string
          description: The ID of the entity this notification relates to
          example: '123456'
        actionUrl:
          type: string
          nullable: true
          description: URL for action button on the notification, if applicable
          example: https://example.com/delegations/123456
        payload:
          type: object
          nullable: true
          description: Additional payload data for the notification
          example:
            assignedBy: John Doe
            priority: high
        relativeTime:
          type: string
          description: Relative time for display (e.g. "2 hours ago")
          example: 2 hours ago
      required:
        - id
        - tenantId
        - templateKey
        - category
        - title
        - message
        - isActionable
        - status
        - createdAt
        - userId
        - entityType
        - entityId
        - relativeTime
  securitySchemes:
    accessToken:
      scheme: bearer
      bearerFormat: JWT
      type: http

````