Notifications


GET /notifications

List the current user's notifications

User-scoped; the row's user_id is the only access boundary. Supports ?unread=true and ?limit.

Auth: Bearer token required

Query parameters

NameTypeDescription
limitintegerMaximum notifications to return
unreadbooleanOnly unread notifications
cursorstringKeyset cursor from the previous page

Responses

StatusDescriptionSchema
200OKNotificationPage
401UnauthorizedError
403ForbiddenError

POST /notifications/{id}/read

Mark a notification read

Auth: Bearer token required

Path parameters

NameTypeDescription
idstring

Responses

StatusDescriptionSchema
200OKNotificationRead
401UnauthorizedError
403ForbiddenError
404Not FoundError

POST /notifications/read-all

Mark all notifications read

Auth: Bearer token required

Responses

StatusDescriptionSchema
200OKNotificationReadAll
401UnauthorizedError
403ForbiddenError

Schemas

Error

FieldTypeDescription
errorstring(required)
codestring

NotificationPage

FieldTypeDescription
itemsobject[](required)
nextCursorstring | nullCursor for the next page; null on the final page (required)
unreadCountinteger(required)

NotificationRead

FieldTypeDescription
idstring(uuid)(required)
readAtstring(required)

NotificationReadAll

FieldTypeDescription
updatedinteger(required)