Notification

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

All the endpoints require the SETTINGS_CRUD permission.

index

get

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

Authorizations
Query parameters
querystring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z ]+$
itemStartnumberOptionalDefault: 0
itemLimitnumber · max: 99OptionalDefault: 15
Responses
200Success
get
GET /api/v2/notification HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content

item

get

Returns this specific notification by its ID.

Authorizations
Path parameters
idnumberRequired
Responses
200Success
get
GET /api/v2/notification/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content

setIsRead

put

Marks this notification as read.

Authorizations
Body
idnumberRequired
Responses
200Success
put
PUT /api/v2/notification/setIsRead HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 8

"id=1"
200Success
No content
PreviousMessageNextRaw