> ## 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.

# Retrieve Deadline Notifications

> Use this endpoint to retrieve active deadlines that are within their notification window, sorted by urgency. Use it to surface upcoming and overdue deadlines to your users.



## OpenAPI

````yaml en/openapi/v3-current/reporter.yaml get /v1/deadlines/notifications
openapi: 3.1.0
info:
  title: Reporter
  description: ''
  version: 2.1.2
servers:
  - url: https://reporter.sandbox.lerian.net
security: []
tags: []
paths:
  /v1/deadlines/notifications:
    get:
      tags:
        - Deadlines API
      summary: Retrieve Deadline Notifications
      description: >-
        Use this endpoint to retrieve active deadlines that are within their
        notification window, sorted by urgency. Use it to surface upcoming and
        overdue deadlines to your users.
      parameters:
        - name: limit
          in: query
          description: >-
            Maximum number of notifications to return. Must be an integer
            between 1 and 100.
          required: false
          example: 10
          schema:
            type: integer
            default: 10
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/XOrganizationId'
      responses:
        '200':
          description: The list of active deadline notifications within their alert window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: >-
                      Deadline notifications within their alert window, sorted
                      by urgency.
                    items:
                      $ref: '#/components/schemas/Deadline'
                  total:
                    type: integer
                    description: Number of notifications returned.
              example:
                total: 1
                items:
                  - id: 00000000-0000-0000-0000-000000000001
                    name: CADOC 4010
                    description: Monthly regulatory report
                    type: regulatory
                    frequency: monthly
                    dueDate: '2026-07-31T00:00:00Z'
                    notifyDaysBefore: 5
                    color: '#ef4444'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error0017:
                  $ref: '#/components/examples/Error0017'
          headers: {}
      security: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: >-
        The authorization token in the 'Bearer <token>' format.  


        **Important:** This header is required if your environment has Access
        Manager enabled. For more information, refer to the [Access
        Manager](/en/access-manager) documentation.
      required: false
      schema:
        type: string
    XOrganizationId:
      name: X-Organization-id
      in: header
      description: The unique identifier of the Organization associated with the request.
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    Deadline:
      type: object
      description: Details about a deadline.
      properties:
        id:
          type: string
          description: Unique identifier of the deadline (UUID).
        name:
          type: string
          description: Human-readable name of the deadline.
        description:
          type: string
          description: Description of the deadline.
        type:
          type: string
          description: Type of the deadline (e.g., `regulatory`, `custom`).
        frequency:
          type: string
          description: How often the deadline recurs (e.g., `monthly`, `annual`).
        dueDate:
          type: string
          description: The date and time when the deadline is due, in RFC 3339 format.
        color:
          type: string
          description: Color used to visually identify the deadline (hex format).
        notifyDaysBefore:
          type: integer
          description: Number of days before the due date when notifications start.
        monthsOfYear:
          type: array
          description: Months of the year (1-12) in which the deadline applies.
          items:
            type: integer
        templateId:
          type: string
          description: >-
            Unique identifier of the template used to fulfill the deadline
            (UUID).
        templateName:
          type: string
          description: Name of the template used to fulfill the deadline.
        status:
          type: string
          description: >-
            Current status of the deadline (e.g., `pending`, `overdue`,
            `delivered`).
        active:
          type: boolean
          description: Whether the deadline is active.
        deliveredAt:
          type: string
          description: Timestamp marking when the deadline was delivered, if applicable.
        createdAt:
          type: string
          description: Timestamp marking when the deadline was created.
        updatedAt:
          type: string
          description: Timestamp marking the last update to the deadline.
    Error:
      type: object
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
      description: Response message error.
      required:
        - code
        - title
        - message
  examples:
    Error0017:
      summary: Bad Request
      value:
        code: TPL-0017
        title: Bad Request
        message: >-
          The server could not understand the request due to malformed syntax.
          Please check the listed fields and try again.

````