Notifications API
User notification API for listing notifications and marking individual or all notifications as read.
Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.
GET /notifications
List User Notifications
List notifications for the current user, newest first.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | -- | integer | Maximum number of records to return. |
offset | query | -- | integer | Number of matching records to skip before returning results. |
unread_only | query | -- | boolean | Whether to return only unread notifications. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested user notifications. | NotificationList |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/notifications \
-H "Authorization: Bearer $TOKEN"POST /notifications/read-all
Mark All Notifications Read
Mark all notifications as read for the current user.
Responses
| Status | Description | Body |
|---|---|---|
204 | Success. No response body is returned. | -- |
Example
curl -X POST http://localhost:8000/notifications/read-all \
-H "Authorization: Bearer $TOKEN"POST /notifications/{notification_id}/read
Mark Notification Read
Mark a single notification as read.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
notification_id | path | yes | string | Identifier of the notification. |
Responses
| Status | Description | Body |
|---|---|---|
204 | Success. No response body is returned. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/notifications/:notification_id/read \
-H "Authorization: Bearer $TOKEN"