Retrieve All Notifications

GET

/v2/api/notification

Enables authenticated users to retrieve a list of notifications, optionally filtered by a specific user ID and limited by a specified notification count.

Functionality

Supports retrieving all notifications or only those associated with a given user_id.

Allows optional notification_count to limit the number of returned notifications (default: 25).

Notifications include detailed metadata such as read status, timestamps, content, and redirection details.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/notification' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

{
    "success": true,
    "message": "Notifications found successfully.",
    "data": [
        {
            "id": 70210,
            "content": "New Feedback - New feedback has been added to the agent 'Policy Whisperer' by user@example.com",
            "is_read": true,
            "created_on": "2025-01-16T10:13:12.760548Z",
            "is_deleted": false,
            "redirection_details": {
                "chatlog_id": 10295,
                "created_by": "user@example.com",
                "created_on": "2025-01-08 21:44:18"
            },
            "recipient": 15,
            "org": 1,
            "agent": null
        }
    ]
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Notifications retrieved successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Create Notification

Read Notifications By User ID