Notification Read Service - API Contract

GET /api/v1/notifications/api/v1/notifications/unread-count

Get unread notification count for a user

Public

Response Example

{
  "data": [
    {
      "user_id": "user_xyz789",
      "unread_count": 12
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

GET /api/v1/notifications/api/v1/notifications/read-receipts/:id

Get read receipt details for a notification

Public

Response Example

{
  "notification_id": "notif_a1b2c3",
  "user_id": "user_xyz789",
  "is_read": true,
  "read_at": "2026-03-26T09:45:22Z"
}

POST /api/v1/notifications/api/v1/notifications/:id/read

Mark a single notification as read

Public

Request Example

{
  "user_id": "user_xyz789"
}

Response Example

{
  "success": true,
  "notification_id": "notif_a1b2c3",
  "read_at": "2026-03-26T09:45:22Z"
}

PUT /api/v1/notifications/api/v1/notifications/read-all

Mark all notifications as read for a user

Public

Request Example

{
  "user_id": "user_xyz789"
}

Response Example

{
  "success": true,
  "user_id": "user_xyz789",
  "marked_count": 12,
  "marked_at": "2026-03-26T09:46:00Z"
}

DELETE /api/v1/notifications/api/v1/notifications/clear-all

Clear (delete) all notifications for a user

Public

Response Example

{
  "success": true,
  "user_id": "user_xyz789",
  "deleted_count": 47,
  "cleared_at": "2026-03-26T09:47:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}