Retrieve Notification Details

Fetches the details of a specific notification by its unique identifier. Use this endpoint to obtain information such as the notification's content, status, and associated metadata.

HTTP Method and URL

GET {{host}}/notifications/:notification_id

Authentication Requirements

Authentication is required. Provide a valid user token in the request headers (e.g., Authorization: Bearer).

Path and Query Parameters

• Path Parameter:

  • notification_id (string, required): The unique identifier of the notification to retrieve.

• Query Parameters:

  • None.

Example Request

GET {{host}}/notifications/12345
Authorization: Bearer <user-token>

Example Successful Response

{
  "notification_id": "12345",
  "title": "Document Approved",
  "content": "Your document has been approved.",
  "status": "read",
  "created_at": "2024-06-01T12:34:56Z",
  "metadata": {
    "document_id": "abcde-12345",
    "actor": "[email protected]"
  }
}

Error Responses

• 404 Not Found: Notification does not exist.

  JSON

      { "error": "Notification not found." }
  

• 401 Unauthorized: Authentication failed or missing.

  JSON

      { "error": "Unauthorized access." }
  

Usage Notes

• Ensure the notification_id is valid and exists in the system.

• Only authorized users can access notification details.

• The response includes all available metadata for the notification.