Skip to content

Gestão — Notificações do Usuário ​

GET /access/auth/notifications ​

Lista as notificações do usuário autenticado com paginação.

Query params:

ParâmetroTipoDescrição
unread_onlybooleanRetornar apenas não lidas (padrão: false)
per_pageintegerPadrão: 15

Response 200:

json
{
  "data": [
    {
      "id": "uuid-notificacao",
      "type": "App\\Notifications\\NewPixReceivedNotification",
      "data": {
        "title": "Pix recebido",
        "message": "Você recebeu R$ 150,00 via Pix.",
        "amount": 150.00
      },
      "read_at": null,
      "created_at": "2025-07-01T14:30:00.000000Z"
    }
  ],
  "meta": { ... },
  "unread_count": 3
}

GET /access/auth/notifications/unread ​

Lista apenas as notificações não lidas.


GET /access/auth/notifications/unread-count ​

Retorna o número de notificações não lidas.

Response 200:

json
{ "unread_count": 3 }

PUT /access/auth/notifications/{id}/read ​

Marca uma notificação específica como lida.

Response 200:

json
{
  "message": "Notificação marcada como lida",
  "notification": { ... }
}

PUT /access/auth/notifications/mark-all-read ​

Marca todas as notificações como lidas.

Response 200:

json
{
    "message": "Todas as notificações foram marcadas como lidas",
    "unread_count": 0
}

DELETE /access/auth/notifications/{id} ​

Remove uma notificação específica.


DELETE /access/auth/notifications/read/all ​

Remove todas as notificações já lidas.

Response 200:

json
{
    "message": "Notificações lidas deletadas com sucesso",
    "deleted_count": 12
}