Notificações do Usuário
Este módulo gerencia as notificações enviadas aos usuários, permitindo listar, marcar como lidas e excluir notificações individuais ou em massa.
[GET] /auth/notifications
Retorna a lista paginada de notificações do usuário autenticado.
Query Parameters
per_page(opcional): Quantidade de registros por página (padrão: 15).unread_only(opcional): Setrue, retorna apenas notificações não lidas.
Response (200 OK)
json
{
"data": [
{
"id": "uuid-da-notificacao",
"type": "App\\Notifications\\DocumentExported",
"data": {
"message": "Seu arquivo de transações em formato PDF está anexado a este email.",
"fileName": "transacoes_2026-05-14_12-04-58.pdf",
"file_url": "http://localhost/storage/exports/transactions/transacoes_2026-05-14_12-04-58.pdf",
"hasFile": true
},
"read_at": null,
"created_at": "2024-05-14T10:00:00.000000Z"
}
],
"links": { ... },
"meta": { ... },
"unread_count": 5
}[GET] /auth/notifications/unread
Retorna apenas as notificações não lidas do usuário.
Response (200 OK)
Semelhante ao endpoint principal, mas filtrado automaticamente.
[GET] /auth/notifications/unread-count
Retorna apenas a contagem de notificações não lidas.
Response (200 OK)
json
{
"unread_count": 5
}[PUT] /auth/notifications/\{id\}/read
Marca uma notificação específica como lida.
Response (200 OK)
json
{
"message": "Notificação marcada como lida",
"notification": { ... }
}[PUT] /auth/notifications/mark-all-read
Marca todas as notificações não lidas do usuário como lidas.
Response (200 OK)
json
{
"message": "Todas as notificações foram marcadas como lidas",
"unread_count": 0
}[DELETE] /auth/notifications/\{id\}
Exclui uma notificação específica.
Response (200 OK)
json
{
"message": "Notificação deletada com sucesso"
}[DELETE] /auth/notifications/read/all
Exclui todas as notificações que já foram lidas pelo usuário.
Response (200 OK)
json
{
"message": "Notificações lidas deletadas com sucesso",
"deleted_count": 10
}