🔔 Notification API Reference

This document provides detailed information about the Notification API endpoints, parameters, and usage examples. For a comprehensive overview of notification features, visit our Notification Guide.

📋 API Endpoints

GET /notifications

Retrieve a list of notification records

• Parameters: limit (default: 10), offset (default: 0), type (e.g., email, sms, webhook)
• Response:

  {
    "notifications": [
      {
        "id": "n12345",
        "type": "email",
        "content": "Your account has been updated!",
        "timestamp": "2023-10-05T14:30:00Z"
      }
    ]
  }
  

POST /notifications

Send a new notification

• Request Body:

  {
    "type": "sms",
    "recipient": "+1234567890",
    "message": "Critical alert: System maintenance in progress"
  }
  

⚠️ Error Codes

📌 Example Usage

curl -X GET "https://api.example.com/notifications?limit=5"

For more details about notification types, see Notification Types.