List Notifications
This API returns a list of notifications generated within the tenant.
Endpoint Details
| URL | /v1/notifications |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Response
Here is an example of a response when viewing a list of data:
Response
{
"items": [
{
"id": "a06a2ed3-3a61-4530-943a-a774400633ce",
"title": "Backup started",
"activity": "Automatic backup \"auto-backup-20260722-100000\" started",
"description": "Backup process started",
"category": 3,
"category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
"severity": 4,
"type": 2,
"channels": [
2
],
"config_notification_id": "9c31eb15-8af7-4488-828c-730e78dd07b3",
"created_at": "2026-07-22T10:00:00+07:00",
},
{
"id": "89812fc7-6591-45d0-97d2-0e401242c10e",
"title": "Key rotated successfully",
"activity": "Ring crypto/72859af3-e342-4440-b8d0-c98acd9ac3e1 rotated v541 → v542",
"description": "Key rotated successfully",
"category": 2,
"category_id": "b2c3d4e5-f6a7-4b5c-9d0e-1f2a3b4c5d6e",
"severity": 4,
"type": 2,
"channels": [
2
],
"config_notification_id": "b5d273bc-cc1f-420d-b07f-5b2ee51b719b",
"created_at": "2026-07-22T09:33:06+07:00",
},
{
"id": "d19030ad-c781-4b18-acee-e40a8e0d6309",
"title": "Key rotation scheduled",
"activity": "Auto-rotation set for ring crypto/72859af3-e342-4440-b8d0-c98acd9ac3e1 every 1h0m0s",
"description": "Key rotation schedule created",
"category": 2,
"category_id": "b2c3d4e5-f6a7-4b5c-9d0e-1f2a3b4c5d6e",
"severity": 3,
"type": 2,
"channels": [
2,
1
],
"config_notification_id": "9a91d205-ca27-4b0f-b767-7cc3e411137c",
"created_at": "2026-07-22T08:33:04+07:00",
}
],
"pagination": {
"total": 3,
"page": 1,
"page_size": 20,
"last_page": 1
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the notification |
| title | String | Title of the notification |
| activity | String | Detailed description of the activity that triggered the notification |
| description | String | Short description of the notification |
| category | Integer | Category code of the notification |
| category_id | UUID | Identifier of the notification category |
| severity | Integer | Severity code of the notification |
| type | Integer | Type code of the notification |
| channels | Array | List of channel codes the notification was delivered through |
| config_notification_id | UUID | Identifier of the notification configuration that produced it |
| created_at | String | Creation timestamp in RFC 3339 date-time format |
| total | Integer | Total number of notifications available |
| page | Integer | Current page number |
| page_size | Integer | Number of records returned per page |
| last_page | Integer | Total number of available pages |
info
- A valid Bearer Token is required to access this endpoint.
- The response returns notifications generated within the tenant.
- The
categoryfield uses the following codes:1= Security & Access Control2= Key Lifecycle3= Backup & Recovery4= System Health & Performance5= Compliance & Audit Trail6= User & Role Management7= Network & Connectivity8= Integration & API Activity9= Operational & Maintenance
- The
severityfield uses the following codes:1= Critical2= High3= Medium4= Low
- The
channelsarray uses the following codes:1= Email2= Dashboard
- Timestamps are returned in RFC 3339 date-time format.