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

# Listar notificações

> Lista as notificações do usuário dono da chave (cada usuário tem as suas). grouped=true traz uma por item pai; groupKey traz as de um item. Andamentos não vêm aqui: use `GET /movements`. Substitui `GET /alert/` e `GET /alert/tabs` (o contador por tipo está em unreadByLink).



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /notifications/list
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /notifications/list:
    get:
      tags:
        - Notifications
      summary: Listar notificações
      description: >-
        Lista as notificações do usuário dono da chave (cada usuário tem as
        suas). grouped=true traz uma por item pai; groupKey traz as de um item.
        Andamentos não vêm aqui: use `GET /movements`. Substitui `GET /alert/` e
        `GET /alert/tabs` (o contador por tipo está em unreadByLink).
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
          in: query
          name: grouped
          required: false
          description: >-
            true: pagina por item pai e traz as notificações de cada um em
            groups
        - schema:
            anyOf:
              - type: string
                enum:
                  - TASK
                  - SUBTASK
                  - WORKFLOW
                  - AUDIENCE
                  - PERSON_BIRTHDAY
                  - USER_BIRTHDAY
                  - WIKI
                  - LAWSUIT_DISCOVERY
              - type: array
                items:
                  type: string
                  enum:
                    - TASK
                    - SUBTASK
                    - WORKFLOW
                    - AUDIENCE
                    - PERSON_BIRTHDAY
                    - USER_BIRTHDAY
                    - WIKI
                    - LAWSUIT_DISCOVERY
          in: query
          name: links
          required: false
          description: Filtra por tipo de vínculo; repita o parâmetro para mais de um
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          in: query
          name: groupKey
          required: false
          description: >-
            Id do item pai (taskId, audienceId...): filtra as notificações
            daquele item
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
          in: query
          name: unread
          required: false
          description: 'true: só não lidas'
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          in: query
          name: orderBy
          required: false
          description: 'Data: desc (mais recentes primeiro, padrão) ou asc'
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
          in: query
          name: bell
          required: false
          description: >-
            true: aplica as preferências do sino (inAppTasks) na lista e na
            contagem
        - schema:
            type: string
            maxLength: 200
          in: query
          name: cursor
          required: false
          description: Cursor devolvido em nextCursor
        - schema:
            type: integer
            exclusiveMinimum: 0
          in: query
          name: page
          required: false
          description: Paginação por página (com total). Sem page, pagina por cursor
        - schema:
            type: integer
            maximum: 100
            default: 20
            exclusiveMinimum: 0
          in: query
          name: limit
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        link:
                          type: string
                          enum:
                            - TASK
                            - SUBTASK
                            - WORKFLOW
                            - AUDIENCE
                            - PERSON_BIRTHDAY
                            - USER_BIRTHDAY
                            - WIKI
                            - LAWSUIT_DISCOVERY
                        groupKey:
                          type: string
                        event:
                          type: string
                        title:
                          type: string
                        body:
                          type: string
                        payload:
                          nullable: true
                        isRead:
                          type: boolean
                        createdAt:
                          type: string
                        taskId:
                          type: string
                          nullable: true
                        subtaskId:
                          type: string
                          nullable: true
                        workflowInstanceId:
                          type: string
                          nullable: true
                        audienceId:
                          type: string
                          nullable: true
                        personId:
                          type: string
                          nullable: true
                        birthdayUserId:
                          type: string
                          nullable: true
                        wikiPageId:
                          type: string
                          nullable: true
                        newLawSuitMonitoringId:
                          type: string
                          nullable: true
                        processNumber:
                          type: string
                          nullable: true
                      required:
                        - id
                        - link
                        - groupKey
                        - event
                        - title
                        - body
                        - isRead
                        - createdAt
                        - taskId
                        - subtaskId
                        - workflowInstanceId
                        - audienceId
                        - personId
                        - birthdayUserId
                        - wikiPageId
                        - newLawSuitMonitoringId
                        - processNumber
                      additionalProperties: false
                    description: Lista plana; vazia com grouped=true
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        link:
                          type: string
                          enum:
                            - TASK
                            - SUBTASK
                            - WORKFLOW
                            - AUDIENCE
                            - PERSON_BIRTHDAY
                            - USER_BIRTHDAY
                            - WIKI
                            - LAWSUIT_DISCOVERY
                        groupKey:
                          type: string
                        parentTitle:
                          type: string
                          nullable: true
                          description: >-
                            Título do item pai (tarefa, audiência, pessoa...);
                            null se não existe mais
                        latestAt:
                          type: string
                        totalCount:
                          type: integer
                        unreadCount:
                          type: integer
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              link:
                                type: string
                                enum:
                                  - TASK
                                  - SUBTASK
                                  - WORKFLOW
                                  - AUDIENCE
                                  - PERSON_BIRTHDAY
                                  - USER_BIRTHDAY
                                  - WIKI
                                  - LAWSUIT_DISCOVERY
                              groupKey:
                                type: string
                              event:
                                type: string
                              title:
                                type: string
                              body:
                                type: string
                              payload:
                                nullable: true
                              isRead:
                                type: boolean
                              createdAt:
                                type: string
                              taskId:
                                type: string
                                nullable: true
                              subtaskId:
                                type: string
                                nullable: true
                              workflowInstanceId:
                                type: string
                                nullable: true
                              audienceId:
                                type: string
                                nullable: true
                              personId:
                                type: string
                                nullable: true
                              birthdayUserId:
                                type: string
                                nullable: true
                              wikiPageId:
                                type: string
                                nullable: true
                              newLawSuitMonitoringId:
                                type: string
                                nullable: true
                              processNumber:
                                type: string
                                nullable: true
                            required:
                              - id
                              - link
                              - groupKey
                              - event
                              - title
                              - body
                              - isRead
                              - createdAt
                              - taskId
                              - subtaskId
                              - workflowInstanceId
                              - audienceId
                              - personId
                              - birthdayUserId
                              - wikiPageId
                              - newLawSuitMonitoringId
                              - processNumber
                            additionalProperties: false
                          description: As notificações mais recentes do item (até 20)
                      required:
                        - link
                        - groupKey
                        - parentTitle
                        - latestAt
                        - totalCount
                        - unreadCount
                        - items
                      additionalProperties: false
                    nullable: true
                    description: >-
                      Só com grouped=true: itens pai paginados, cada um com as
                      suas notificações
                  nextCursor:
                    type: string
                    nullable: true
                  totalResults:
                    type: integer
                    nullable: true
                    description: Só com page
                  totalPages:
                    type: integer
                    nullable: true
                    description: Só com page
                  unread:
                    type: integer
                    description: >-
                      Não lidas do usuário nos tipos filtrados por links (sem
                      links: todas)
                  unreadByLink:
                    type: object
                    additionalProperties:
                      type: integer
                    description: >-
                      Não lidas do usuário por tipo, sem filtro (contador de
                      cada aba)
                required:
                  - data
                  - groups
                  - nextCursor
                  - totalResults
                  - totalPages
                  - unread
                  - unreadByLink
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  issues: {}
                required:
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.