Retrieve Notification

GET

/v2/api/notification/{notification_id}

Enables authenticated users to retrieve the complete details of a specific notification by providing its unique notification_id in the path.

Functionality

Fetches a single notification resource from the system.

Returns comprehensive information including content, read status, creation timestamp, redirection metadata, and associated user and organizational context.

Designed to support detailed notification viewing for end users and administrators.

What is a Notification ID?

A Notification ID is a unique identifier assigned to each notification generated within a system.
It acts as a reference ID that helps in tracking, managing, and interacting with specific notifications.

Purpose of Notification ID

To uniquely identify a notification in the system.

To perform operations like marking as read, deleting, or updating a specific notification.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Notification retrieved successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "success": true,
    "message": "Notifications found successfully.",
    "data": {
        "id": 69961,
        "content": "Test Notification",
        "is_read": true,
        "created_on": "2025-01-07T22:56:18.953492Z",
        "is_deleted": false,
        "redirection_details": {},
        "recipient": 160,
        "org": 1,
        "agent": 1251
    }
}

Read Notifications By User ID

Read Notification

Retrieve Notification

What is a Notification ID?#

Purpose of Notification ID#

Request

Responses

What is a Notification ID?

Purpose of Notification ID