Get a Notification

GET

/api/v2/notifications/{notification_id}

Retrieves a specific notification by notification_id.

Purpose:

This endpoint fetches a specific notification by its unique identifier.

Path Parameters:

notification_id (int): The ID of the notification to retrieve.

Returns:

200 OK: The notification is found.

400 Bad Request: If versioning fails or invalid parameters are passed.

404 Not Found: If the notification is not found.

500 Internal Server Error: On unhandled exceptions.

Current Version: 2.0.1

Changelog:

2.0.1: Improved the fetching of notification as per the authenticated user without need of user_id query parameter.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "content": "string",
        "is_read": true,
        "created_on": "2019-08-24T14:15:22Z",
        "is_deleted": true,
        "redirection_details": {
            "property1": null,
            "property2": null
        },
        "recipient": 0,
        "org": 0,
        "agent": 0
    }
}

Update Notifications by User ID

Update a Notification