Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ShohjahonSohibov/repo-for-agent/llms.txt

Use this file to discover all available pages before exploring further.

The Notifications API lets each authenticated user retrieve and manage their own in-app alerts — such as load status changes, driver assignments, and system events. All notification endpoints are scoped to the currently authenticated user and require only a valid JWT; no additional permission is needed. Related controllers expose user activity logs, system action logs, and the auditable change trail for compliance purposes.

​
NotificationsController — /api/notifications

In-app notification management. All endpoints require a valid JWT; no specific permission code is required beyond authentication.

​
GET /api/notifications

List all notifications for the currently authenticated user, ordered by most recent first. Required permission: Authenticated (any valid JWT)
cURL
curl https://your-domain.com/api/notifications \
  -H "Authorization: Bearer <accessToken>"
Response
{
  "items": [
    {
      "id": 201,
      "title": "Load #1045 status changed",
      "body": "Load 1045 has been marked as InTransit.",
      "isRead": false,
      "createdAt": "2026-05-11T09:15:00Z"
    }
  ],
  "totalCount": 14,
  "page": 1,
  "pageSize": 20,
  "totalPages": 1
}

​
GET /api/notifications/{id}

Retrieve the details of a single notification. Required permission: Authenticated
​
id
number
required
The notification’s database ID.
Response fields
​
id
number
required
Notification ID.
​
title
string
required
Short title of the notification.
​
body
string
Full notification message body.
​
isRead
boolean
required
Whether the user has read this notification.
​
createdAt
string
required
ISO 8601 timestamp when the notification was created.

​
PUT /api/notifications/{id}/read

Mark a single notification as read. Required permission: Authenticated
​
id
number
required
The notification’s database ID.
cURL
curl -X PUT https://your-domain.com/api/notifications/201/read \
  -H "Authorization: Bearer <accessToken>"

​
PUT /api/notifications/read-all

Mark all notifications for the current user as read in a single request. Required permission: Authenticated
cURL
curl -X PUT https://your-domain.com/api/notifications/read-all \
  -H "Authorization: Bearer <accessToken>"

​
DELETE /api/notifications/{id}

Delete a notification permanently for the current user. Required permission: Authenticated
​
id
number
required
The notification’s database ID.
cURL
curl -X DELETE https://your-domain.com/api/notifications/201 \
  -H "Authorization: Bearer <accessToken>"

​
User logs

​
UserLogsController — /api/user-logs

Track user activity within the system. Useful for understanding how dispatchers and managers are using the application.
MethodEndpointPermissionDescription
GET/api/user-logsUserLogs.ViewList all user activity logs
GET/api/user-logs/{userId}UserLogs.ViewGet logs for a specific user
cURL
curl https://your-domain.com/api/user-logs/5 \
  -H "Authorization: Bearer <accessToken>"

​
ActionLogsController — /api/action-logs

System-level action logs record discrete operations performed by background jobs, webhooks, and integrations — separate from user-initiated actions.
MethodEndpointPermissionDescription
GET/api/action-logsActionLogs.ViewList all action logs

​
AuditLogsController — /api/audit-logs

The audit log captures every create, update, and delete operation on important entities, recording the before and after state, the acting user, and the timestamp. Use this for compliance, debugging, and change tracking. Required permission: AuditLogs.View
MethodEndpointDescription
GET/api/audit-logsList audit log entries with filters
GET/api/audit-logs/{id}Get a specific audit log entry
cURL
curl "https://your-domain.com/api/audit-logs?fromDate=2026-05-01&toDate=2026-05-11" \
  -H "Authorization: Bearer <accessToken>"
Response
{
  "items": [
    {
      "id": 5001,
      "entityType": "Load",
      "entityId": 1045,
      "action": "Update",
      "changedBy": 3,
      "changedAt": "2026-05-10T14:22:00Z",
      "changes": {
        "status": { "from": "Dispatched", "to": "InTransit" }
      }
    }
  ],
  "totalCount": 112,
  "page": 1,
  "pageSize": 20,
  "totalPages": 6
}
Telegram notifications are managed separately from in-app notifications. Configure Telegram group subscriptions via /api/group-links and control which events trigger Telegram messages via /api/notification-settings.
User-level notification preferences — such as which event types trigger in-app alerts — are stored at /api/notification-settings. Use GET /api/notification-settings to retrieve the current configuration and PUT /api/notification-settings to update it.

Build docs developers (and LLMs) love

Get started for freeTalk to us