> For the complete documentation index, see [llms.txt](https://dev.guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.guardian.hedera.com/static-spec-test/platform/notifications.md).

# Notifications

## Get all notifications

> Returns all notifications.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"notifications"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who owns this notification"},"title":{"type":"string","description":"Notification title (e.g. \"Policy published\", \"Schema created\")"},"message":{"type":"string","description":"Detailed notification message"},"type":{"type":"string","description":"Notification type","enum":["INFO","ERROR","WARN","SUCCESS"]},"action":{"type":"string","description":"Action that triggered the notification (used for navigation in UI)","enum":["POLICY_CONFIGURATION","POLICY_VIEW","POLICIES_PAGE","SCHEMAS_PAGE","TOKENS_PAGE","PROFILE_PAGE","POLICY_LABEL_PAGE"]},"result":{"type":"object","description":"Result ID (e.g. policy ID, schema ID) for navigation"},"read":{"type":"boolean","description":"Whether the notification has been read"},"old":{"type":"boolean","description":"Whether the notification is old (already shown to user)"}},"required":["id","createDate","updateDate","userId","title","message","type","action","result","read","old"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/notifications":{"get":{"description":"Returns all notifications.","operationId":"NotificationsApi_getAllNotifications","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation. Returns notifications and count.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get all notifications","tags":["notifications"]}}}}
```

## Get new notifications

> Returns new notifications.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"notifications"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who owns this notification"},"title":{"type":"string","description":"Notification title (e.g. \"Policy published\", \"Schema created\")"},"message":{"type":"string","description":"Detailed notification message"},"type":{"type":"string","description":"Notification type","enum":["INFO","ERROR","WARN","SUCCESS"]},"action":{"type":"string","description":"Action that triggered the notification (used for navigation in UI)","enum":["POLICY_CONFIGURATION","POLICY_VIEW","POLICIES_PAGE","SCHEMAS_PAGE","TOKENS_PAGE","PROFILE_PAGE","POLICY_LABEL_PAGE"]},"result":{"type":"object","description":"Result ID (e.g. policy ID, schema ID) for navigation"},"read":{"type":"boolean","description":"Whether the notification has been read"},"old":{"type":"boolean","description":"Whether the notification is old (already shown to user)"}},"required":["id","createDate","updateDate","userId","title","message","type","action","result","read","old"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/notifications/new":{"get":{"description":"Returns new notifications.","operationId":"NotificationsApi_getNewNotifications","parameters":[],"responses":{"200":{"description":"Successful operation. Returns new notifications.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get new notifications","tags":["notifications"]}}}}
```

## Get progresses

> Returns progresses.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"notifications"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProgressDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who initiated the action"},"action":{"type":"string","description":"Action being tracked (e.g. \"Publish policy\")"},"message":{"type":"string","description":"Current progress message"},"progress":{"type":"number","description":"Progress percentage (0-100)"},"type":{"type":"string","description":"Progress type","enum":["INFO","ERROR","WARN","SUCCESS"]},"taskId":{"type":"string","description":"Associated task ID"}},"required":["id","createDate","updateDate","userId","action","message","progress","type","taskId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/notifications/progresses":{"get":{"description":"Returns progresses.","operationId":"NotificationsApi_getProgresses","parameters":[],"responses":{"200":{"description":"Successful operation. Returns progresses.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProgressDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get progresses","tags":["notifications"]}}}}
```

## Read all notifications

> Marks all notifications as read and returns them.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"notifications"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who owns this notification"},"title":{"type":"string","description":"Notification title (e.g. \"Policy published\", \"Schema created\")"},"message":{"type":"string","description":"Detailed notification message"},"type":{"type":"string","description":"Notification type","enum":["INFO","ERROR","WARN","SUCCESS"]},"action":{"type":"string","description":"Action that triggered the notification (used for navigation in UI)","enum":["POLICY_CONFIGURATION","POLICY_VIEW","POLICIES_PAGE","SCHEMAS_PAGE","TOKENS_PAGE","PROFILE_PAGE","POLICY_LABEL_PAGE"]},"result":{"type":"object","description":"Result ID (e.g. policy ID, schema ID) for navigation"},"read":{"type":"boolean","description":"Whether the notification has been read"},"old":{"type":"boolean","description":"Whether the notification is old (already shown to user)"}},"required":["id","createDate","updateDate","userId","title","message","type","action","result","read","old"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/notifications/read/all":{"post":{"description":"Marks all notifications as read and returns them.","operationId":"NotificationsApi_readAll","parameters":[],"responses":{"200":{"description":"Successful operation. Returns notifications.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Read all notifications","tags":["notifications"]}}}}
```

## Delete notifications up to this point

> Returns deleted notifications count.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"notifications"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/notifications/delete/{notificationId}":{"delete":{"description":"Returns deleted notifications count.","operationId":"NotificationsApi_delete","parameters":[{"name":"notificationId","required":true,"in":"path","description":"Notification Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation. Returns deleted notifications count.","content":{"application/json":{"schema":{"type":"number"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Delete notifications up to this point","tags":["notifications"]}}}}
```