Skip to content

Notifications API

All endpoints require authentication. Base path: /api/v1/notifications.

MethodPathDescription
GET/v1/notificationsList unread in-app notifications
POST/v1/notifications/read-allMark all notifications as read
PUT/v1/notifications/{notification}/readMark a single notification as read
MethodPathDescription
GET/v1/notifications/push/vapid-keyGet the VAPID public key
POST/v1/notifications/push/subscribeRegister a Web Push subscription (endpoint, keys.auth, keys.p256dh)
POST/v1/notifications/push/unsubscribeRemove a push subscription (endpoint)
MethodPathDescription
GET/v1/notifications/settingsGet per-type × per-channel notification settings
PUT/v1/notifications/settingsUpdate per-type × per-channel toggles

The settings are a matrix of the 9 notification types (music/book/movie release, friend request, daily day reminder, daily check-in reminder, calendar share, dev request comment, export ready) each with four channel flags (_ui, _email, _push, _telegram). See Notifications for the full matrix.