Alerts API
Auto-generated from
openapi-snapshot.json. Do not edit by hand — changes are overwritten byscripts/docs/generate_api_reference.py.
7 endpoints in this group.
GET /api/alerts/capabilities
Get Alert Capabilities
Return server-owned alert types, channels, thresholds, and caps.
Responses
| Code | Description |
|---|---|
200 | Successful Response |
GET /api/alerts/deliveries
List Deliveries
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | optional | |
alert_type | query | — | optional |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/alerts/in-app
List In App
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
unread | query | boolean | optional | |
limit | query | — | optional | |
page | query | integer | optional | 1-based page index. |
page_size | query | integer | optional | Page size — must be one of 25, 50, 100. |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
POST /api/alerts/in-app/read-all
Mark All Read
Responses
| Code | Description |
|---|---|
200 | Successful Response |
POST /api/alerts/in-app/{item_id}/read
Mark Read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
item_id | path | integer | required |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/alerts/prefs
List Prefs
Responses
| Code | Description |
|---|---|
200 | Successful Response |
PUT /api/alerts/prefs
Upsert Prefs
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |