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

GET /notifications/list

Listar notificações

cURL

curl --request GET \
  --url https://api.juridiq.com.br/notifications/list \
  --header 'x-juridiq-api-key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "link": "TASK",
      "groupKey": "<string>",
      "event": "<string>",
      "title": "<string>",
      "body": "<string>",
      "isRead": true,
      "createdAt": "<string>",
      "taskId": "<string>",
      "subtaskId": "<string>",
      "workflowInstanceId": "<string>",
      "audienceId": "<string>",
      "personId": "<string>",
      "birthdayUserId": "<string>",
      "wikiPageId": "<string>",
      "newLawSuitMonitoringId": "<string>",
      "processNumber": "<string>",
      "payload": null
    }
  ],
  "groups": [
    {
      "link": "TASK",
      "groupKey": "<string>",
      "parentTitle": "<string>",
      "latestAt": "<string>",
      "totalCount": 123,
      "unreadCount": 123,
      "items": [
        {
          "id": "<string>",
          "link": "TASK",
          "groupKey": "<string>",
          "event": "<string>",
          "title": "<string>",
          "body": "<string>",
          "isRead": true,
          "createdAt": "<string>",
          "taskId": "<string>",
          "subtaskId": "<string>",
          "workflowInstanceId": "<string>",
          "audienceId": "<string>",
          "personId": "<string>",
          "birthdayUserId": "<string>",
          "wikiPageId": "<string>",
          "newLawSuitMonitoringId": "<string>",
          "processNumber": "<string>",
          "payload": null
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "totalResults": 123,
  "totalPages": 123,
  "unread": 123,
  "unreadByLink": {}
}

Authorizations

x-juridiq-api-key · string · header · required

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

Query Parameters

grouped · enum<string> boolean

true: pagina por item pai e traz as notificações de cada um em groups

Available options: true, false

links · enum<string> enum<string>[]

Filtra por tipo de vínculo; repita o parâmetro para mais de um

Available options: TASK, SUBTASK, WORKFLOW, AUDIENCE, PERSON_BIRTHDAY, USER_BIRTHDAY, WIKI, LAWSUIT_DISCOVERY

groupKey · string

Id do item pai (taskId, audienceId...): filtra as notificações daquele item

Required string length: 1 - 200

unread · enum<string> boolean

true: só não lidas

Available options: true, false

orderBy · enum<string> · default: desc

Data: desc (mais recentes primeiro, padrão) ou asc

Available options: asc, desc

bell · enum<string> boolean

true: aplica as preferências do sino (inAppTasks) na lista e na contagem

Available options: true, false

cursor · string

Cursor devolvido em nextCursor

Maximum string length: 200

page · integer

Paginação por página (com total). Sem page, pagina por cursor

limit · integer · default: 20

Required range: x <= 100

Response

200

application/json

Default Response

data · object[] · required

Lista plana; vazia com grouped=true

Show child attributes

groups · object[] | null · required

Só com grouped=true: itens pai paginados, cada um com as suas notificações

Show child attributes

nextCursor · string | null · required

totalResults · integer | null · required

Só com page

totalPages · integer | null · required

Só com page

unread · integer · required

Não lidas do usuário nos tipos filtrados por links (sem links: todas)

unreadByLink · object · required

Não lidas do usuário por tipo, sem filtro (contador de cada aba)

Show child attributes