Notifications

Per-user notification surface — a projection of the audit log filtered to events the caller is allowed to see. Drives the bell + dropdown in the operator portal.

Notifications

Operations

GET/api/notificationsGET/api/notifications/unread-countPOST/api/notifications/{id}/readPOST/api/notifications/read-all

---

List notifications visible to the caller

GET

/api/notifications

Reverse-chronological. Pass the oldest result's timestamp back as before to paginate.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Query Parameters

limit

Default 20.

Type

number

unreadOnly

Default false.

Type

boolean

before

ISO timestamp cursor.

Type

string

Responses

Content-Type

application/json

[

{

}

]

GET

/api/notifications

Playground

Server

Authorization

bearer

Variables

Key

Value

limit

unreadOnly

before

Samples

---

Number of unread notifications

GET

/api/notifications/unread-count

Cheap polling endpoint — drives the notification-bell badge.

Authorizations

bearer

Type

HTTP (bearer)

Responses

GET

/api/notifications/unread-count

Playground

Server

Authorization

bearer

Samples

---

Mark a single notification read

POST

/api/notifications/{id}/read

Idempotent. The id is the underlying audit-event id.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Responses

POST

/api/notifications/{id}/read

Playground

Server

Authorization

bearer

Variables

Key

Value

id*

Samples

---

Mark every visible notification read

POST

/api/notifications/read-all

Returns { marked: <count> } with the number of new read-rows inserted.

Authorizations

bearer

Type

HTTP (bearer)

Responses

POST

/api/notifications/read-all

Playground

Server

Authorization

bearer

Samples

---

Powered by VitePress OpenAPI