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

# List deadline notifications

> Returns active deadlines inside their notification window, ordered by urgency.



## OpenAPI

````yaml en/openapi/v3-current/reporter.yaml get /v1/deadlines/notifications
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    This is OpenAPI documentation for Reporter. The unified reporter binary
    serves the REST API (RUN_MODE=api) and/or the RabbitMQ report-generation
    worker (RUN_MODE=worker); RUN_MODE=all runs both in one process for local
    development. All REST endpoints documented here serve only when RUN_MODE=api
    or all (port :4005); the worker (port :4006) exposes health/readyz only.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Generated report instances and their lifecycle.
    name: Reports
  - description: Reusable report definitions.
    name: Templates
  - description: Interactive construction of report templates.
    name: Template Builder
  - description: Scheduled report due-date tracking.
    name: Deadlines
  - description: Configured inputs that feed report data.
    name: Data Sources
  - description: Aggregated reporting metrics.
    name: Metrics
  - description: Published business event catalog and delivery policies.
    name: Streaming
paths:
  /v1/deadlines/notifications:
    get:
      tags:
        - Deadlines
      summary: List deadline notifications
      description: >-
        Returns active deadlines inside their notification window, ordered by
        urgency.
      operationId: listDeadlineNotifications
      parameters:
        - description: Maximum number of notifications to return, from 1 through 100.
          example: 10
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: Maximum number of notifications to return, from 1 through 100.
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
components:
  schemas:
    NotificationResponse:
      properties:
        items:
          description: Deadline notifications inside their notification window.
          examples:
            - - color: '#EF4444'
                daysUntilDue: 3
                description: Monthly regulatory report
                dueDate: '2026-07-31T00:00:00Z'
                frequency: monthly
                id: 00000000-0000-0000-0000-000000000001
                name: CADOC 4010
                notifyDaysBefore: 5
                severity: warning
                type: regulatory
          items:
            $ref: '#/components/schemas/NotificationItem'
          type:
            - array
            - 'null'
        total:
          description: Number of notifications returned.
          examples:
            - 3
          format: int64
          type: integer
      type: object
    Detail:
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    NotificationItem:
      properties:
        color:
          description: Hex color used to identify the deadline.
          examples:
            - '#ef4444'
          type: string
        daysUntilDue:
          description: Days until the deadline, or negative days when overdue.
          examples:
            - 3
          format: int64
          type: integer
        description:
          description: Optional deadline description.
          examples:
            - Monthly regulatory report
          type: string
        dueDate:
          description: Deadline due date and time in RFC 3339 format.
          examples:
            - '2026-07-31T00:00:00Z'
          format: date-time
          type: string
        frequency:
          description: Deadline recurrence frequency.
          examples:
            - monthly
          type: string
        id:
          description: Unique deadline identifier.
          examples:
            - 00000000-0000-0000-0000-000000000001
          type: string
        monthsOfYear:
          description: Months in which a semiannual or annual deadline occurs.
          examples:
            - - 1
              - 6
              - 12
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        name:
          description: Human-readable deadline name.
          examples:
            - CADOC 4010
          type: string
        notifyDaysBefore:
          description: Days before the due date when notifications begin.
          examples:
            - 5
          format: int64
          type: integer
        severity:
          description: Notification urgency level.
          examples:
            - warning
          type: string
        type:
          description: Deadline category.
          examples:
            - regulatory
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Error message text
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: The value at the given location
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````