# Notification

**All the endpoints that can be called on the Notification controller.**

All the endpoints require the `SETTINGS_CRUD` permission.

## index

> \*\*Returns all notifications for this user found by UID and marks them all as read.\*\*

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.0.0"},"tags":[{"name":"Notification","description":"**All the endpoints that can be called on the Notification controller.**\n\nAll the endpoints require the `SETTINGS_CRUD` permission."}],"servers":[{"url":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}},"parameters":{"query":{"name":"query","in":"query","schema":{"type":"string","pattern":"^[0-9a-zA-Z ]+$","minLength":1,"default":""}},"itemStart":{"name":"itemStart","in":"query","schema":{"type":"number","default":0}},"itemLimit":{"name":"itemLimit","in":"query","schema":{"type":"number","maximum":99,"default":15}}}},"paths":{"/api/v2/notification":{"get":{"tags":["Notification"],"summary":"index","description":"**Returns all notifications for this user found by UID and marks them all as read.**","operationId":"notificationIndexGET","parameters":[{"$ref":"#/components/parameters/query"},{"$ref":"#/components/parameters/itemStart"},{"$ref":"#/components/parameters/itemLimit"}],"responses":{"200":{"description":""}}}}}}
```

## item

> \*\*Returns this specific notification by its ID.\*\*

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.0.0"},"tags":[{"name":"Notification","description":"**All the endpoints that can be called on the Notification controller.**\n\nAll the endpoints require the `SETTINGS_CRUD` permission."}],"servers":[{"url":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/notification/{id}":{"get":{"tags":["Notification"],"summary":"item","description":"**Returns this specific notification by its ID.**","operationId":"notificationItemGET","responses":{"200":{"description":""}}}}}}
```

## setIsRead

> \*\*Marks this notification as read.\*\*

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.0.0"},"tags":[{"name":"Notification","description":"**All the endpoints that can be called on the Notification controller.**\n\nAll the endpoints require the `SETTINGS_CRUD` permission."}],"servers":[{"url":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/notification/setIsRead":{"put":{"tags":["Notification"],"summary":"setIsRead","description":"**Marks this notification as read.**","operationId":"setIsReadPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```