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

# Recuperar notificações de prazos

> Use este endpoint para recuperar os prazos ativos que estão dentro da sua janela de notificação, ordenados por urgência. Use-o para exibir aos seus usuários os prazos próximos e vencidos.



## OpenAPI

````yaml pt/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: Recuperar notificações de prazos
      description: >-
        Use este endpoint para recuperar os prazos ativos que estão dentro da
        sua janela de notificação, ordenados por urgência. Use-o para exibir aos
        seus usuários os prazos próximos e vencidos.
      parameters:
        - name: limit
          in: query
          description: >-
            Número máximo de notificações retornadas. Deve ser um inteiro entre
            1 e 100.
          required: false
          example: 10
          schema:
            type: integer
            default: 10
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/XOrganizationId'
      responses:
        '200':
          description: >-
            A lista de notificações de prazos ativos dentro da sua janela de
            alerta.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: >-
                      Notificações de prazos dentro da sua janela de alerta,
                      ordenadas por urgência.
                    items:
                      $ref: '#/components/schemas/Deadline'
                  total:
                    type: integer
                    description: Número de notificações retornadas.
              example:
                total: 1
                items:
                  - id: 00000000-0000-0000-0000-000000000001
                    name: CADOC 4010
                    description: Relatório regulatório mensal
                    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: >-
        O token de autorização no formato 'Bearer <token>'.  


        **Importante:** Este header é obrigatório se o seu ambiente tiver o
        Access Manager habilitado. Para mais informações, consulte a
        documentação do [Access Manager](/pt/access-manager).
      required: false
      schema:
        type: string
    XOrganizationId:
      name: X-Organization-id
      in: header
      description: O identificador único da Organização associada à requisição.
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    Deadline:
      type: object
      description: Detalhes sobre um prazo.
      properties:
        id:
          type: string
          description: Identificador único do prazo (UUID).
        name:
          type: string
          description: Nome legível do prazo.
        description:
          type: string
          description: Descrição do prazo.
        type:
          type: string
          description: Tipo do prazo (ex. `regulatory`, `custom`).
        frequency:
          type: string
          description: Com que frequência o prazo se repete (ex. `monthly`, `annual`).
        dueDate:
          type: string
          description: Data e hora de vencimento do prazo, no formato RFC 3339.
        color:
          type: string
          description: >-
            Cor usada para identificar visualmente o prazo (formato
            hexadecimal).
        notifyDaysBefore:
          type: integer
          description: >-
            Número de dias antes da data de vencimento em que as notificações
            começam.
        monthsOfYear:
          type: array
          description: Meses do ano (1-12) em que o prazo se aplica.
          items:
            type: integer
        templateId:
          type: string
          description: Identificador único do template usado para cumprir o prazo (UUID).
        templateName:
          type: string
          description: Nome do template usado para cumprir o prazo.
        status:
          type: string
          description: Status atual do prazo (ex. `pending`, `overdue`, `delivered`).
        active:
          type: boolean
          description: Indica se o prazo está ativo.
        deliveredAt:
          type: string
          description: Data e hora em que o prazo foi entregue, se aplicável.
        createdAt:
          type: string
          description: Data e hora em que o prazo foi criado.
        updatedAt:
          type: string
          description: Data e hora da última atualização do prazo.
    Error:
      type: object
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
      description: Mensagem de erro da resposta.
      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.

````