Notifications API

Read the authenticated account's notification records.

Endpoints

MethodPathDescription
GET/v1/notificationsList notifications for the authenticated account.
PATCH/v1/notifications/:idMark a notification as read.

The Notification Object

Notification object
{
  "id": "ntf_2c81f0",
  "type": "order_status_changed",
  "orderId": "ord_51c9a2",
  "message": "Order ord_51c9a2 status changed to fulfilling",
  "read": false,
  "createdAt": "2026-02-01T12:15:00Z"
}

Mark as Read

Request
curl -X PATCH https://api.baalvion.com/v1/notifications/ntf_2c81f0 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "read": true }'

For real-time delivery instead of polling, subscribe to the equivalent events via Webhooks.