notifications
5 endpoints
get /notifications
List the notification inbox
Requires authentication
Returns the caller's paginated in-app notifications plus a top-level unreadCount for the bell badge.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer | no | Page size (default 50, max 100) |
| offset | query | integer | no | Offset into the list (default 0) |
Responses
- 200 OK · apimodel.NotificationListResponse
- 401 Unauthorized · apimodel.ErrorEnvelope
post /notifications/{id}/read
Mark a notification read
Requires authentication
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Notification id |
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope
post /notifications/mark-by-entity
Mark notifications read by entity
Requires authentication
Clears every unread notification tied to a given entity (e.g. all rows for bug 42) in one call.
Request body: apimodel.MarkByEntityRequest
| Name | Type | Required | Description |
|---|---|---|---|
| entityId | integer | no | |
| entityType | string | no |
Responses
- 200 OK · object
- 400 Bad Request · apimodel.ErrorEnvelope
- 401 Unauthorized · apimodel.ErrorEnvelope
post /notifications/read-all
Mark all notifications read
Requires authentication
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope
get /notifications/unread-count
Get the unread notification count
Requires authentication
Responses
- 200 OK · object
- 401 Unauthorized · apimodel.ErrorEnvelope