Retrieves a list of notifications
GET <your-unleash-url>/api/admin/notifications
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
A user may get relevant notifications from the projects they are a member of
Request
Responses
- 200
notificationsSchema
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- id number required
The id of this notification
- message string required
The actual notification message
- link string required
The link to change request or feature toggle the notification refers to
- notificationType required
Possible values: [
change-request
,toggle
]The type of the notification used e.g. for the graphical hints
createdBy objectrequired
- createdAt date-time required
The date and time when the notification was created
- readAt date-time nullable required
The date and time when the notification was read or marked as read, otherwise
null
- ]
[
{
"id": 1,
"message": "Your change request got approved",
"link": "/myunleash/projects/myproject/change-requests/46",
"createdBy": {
"username": "Jane Smith",
"imageUrl": "https://gravatar.com/avatar/758f27d1f066779a62a65665242b8780107df403509a62a9e8a5924df5469f68?s=42&d=retro&r=g"
},
"createdAt": "2022-12-02T13:17:12.445Z",
"readAt": "2022-12-02T13:17:12.445Z"
}
]
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / axios
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / RestSharp
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/notifications' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'