Notifications Application

This section describes the API endpoints for managing notifications.

Base URL: /

Authentication:

Most API calls require authorization with a valid access token. You can obtain an access token by logging in with a username and password (refer to Accounts section).

Get Inbox Notifications

• Method: GET
• Endpoints: /notifications/inbox/
• Authorization: Bearer <access_token>
• Response:

{
  "notifications": [
    # List of notifications of the current user.
  ]
}

• Description: Get a list of notifications for the currently logged-in user.

Get Notification Badge Count

• Method: GET
• Endpoints: /notifications/badge/
• Authorization: Bearer <access_token>
• Response:

{
  "total_count": integer
}

• Description: Get the total number of unread notifications for the currently logged-in user.

Mark All Notifications as Read

• Method: PATCH
• Endpoints: /notifications/mark/all/
• Authorization: Bearer <access_token>
• Response:

{
  "message": "All notifications have been marked as read."
}

• Description: Mark all unread notifications for the currently logged-in user as read.