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

# Obtener notificaciones de plazos

> Utiliza este endpoint para obtener los plazos activos que se encuentran dentro de su ventana de notificación, ordenados por urgencia. Úsalo para mostrar a tus usuarios los plazos próximos y vencidos.



## OpenAPI

````yaml es/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:
        - API de plazos
      summary: Obtener notificaciones de plazos
      description: >-
        Utiliza este endpoint para obtener los plazos activos que se encuentran
        dentro de su ventana de notificación, ordenados por urgencia. Úsalo para
        mostrar a tus usuarios los plazos próximos y vencidos.
      parameters:
        - name: limit
          in: query
          description: >-
            Número máximo de notificaciones que se devuelven. Debe ser un entero
            entre 1 y 100.
          required: false
          example: 10
          schema:
            type: integer
            default: 10
        - $ref: b9b1db5c-977d-4f56-a2eb-131262b6d1ca
        - $ref: '#/components/parameters/XOrganizationId'
      responses:
        '200':
          description: >-
            La lista de notificaciones de plazos activos dentro de su ventana de
            alerta.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: >-
                      Notificaciones de plazos dentro de su ventana de alerta,
                      ordenadas por urgencia.
                    items:
                      $ref: '#/components/schemas/Deadline'
                  total:
                    type: integer
                    description: Número de notificaciones devueltas.
              example:
                total: 1
                items:
                  - id: 00000000-0000-0000-0000-000000000001
                    name: CADOC 4010
                    description: Informe regulatorio mensual
                    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:
    XOrganizationId:
      name: X-Organization-id
      in: header
      description: El identificador único de la Organización asociada a la solicitud.
      required: false
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    Deadline:
      type: object
      description: Detalles sobre un plazo.
      properties:
        id:
          type: string
          description: Identificador único del plazo (UUID).
        name:
          type: string
          description: Nombre legible del plazo.
        description:
          type: string
          description: Descripción del plazo.
        type:
          type: string
          description: Tipo del plazo (p. ej., `regulatory`, `custom`).
        frequency:
          type: string
          description: Con qué frecuencia se repite el plazo (p. ej., `monthly`, `annual`).
        dueDate:
          type: string
          description: Fecha y hora de vencimiento del plazo, en formato RFC 3339.
        color:
          type: string
          description: >-
            Color usado para identificar visualmente el plazo (formato
            hexadecimal).
        notifyDaysBefore:
          type: integer
          description: >-
            Número de días antes de la fecha de vencimiento en que comienzan las
            notificaciones.
        monthsOfYear:
          type: array
          description: Meses del año (1-12) en los que aplica el plazo.
          items:
            type: integer
        templateId:
          type: string
          description: >-
            Identificador único de la plantilla usada para cumplir el plazo
            (UUID).
        templateName:
          type: string
          description: Nombre de la plantilla usada para cumplir el plazo.
        status:
          type: string
          description: Estado actual del plazo (p. ej., `pending`, `overdue`, `delivered`).
        active:
          type: boolean
          description: Indica si el plazo está activo.
        deliveredAt:
          type: string
          description: Fecha y hora en que se entregó el plazo, si aplica.
        createdAt:
          type: string
          description: Fecha y hora en que se creó el plazo.
        updatedAt:
          type: string
          description: Fecha y hora de la última actualización del plazo.
    Error:
      type: object
      properties:
        code:
          type: string
          description: Un identificador único y estable para el error.
        title:
          type: string
          description: Un breve resumen del problema.
        message:
          type: string
          description: Orientación detallada para resolver el error.
      description: Mensaje de error de la respuesta.
      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.

````