Retrieves a list of notifications

GET 
<your-unleash-url>/api/admin/notifications

A user may get relevant notifications from the projects they are a member of

Responses

200

notificationsSchema

application/json

Schema

Schema

Array [
idnumberrequired
The id of this notification
Example: 1
messagestringrequired
The actual notification message
Example: Your change request got approved
linkstringrequired
The link to change request or feature flag the notification refers to
Example: /myunleash/projects/myproject/change-requests/46
notificationTyperequired
The type of the notification used e.g. for the graphical hints
Possible values: [change-request, toggle]
createdBy objectrequired
usernamestringnullable
The name of the user who triggered the notification
Example: Jane Smith
imageUrlstringnullable
The avatar url of the user who triggered the notification
Example: https://gravatar.com/avatar/758f27d1f066779a62a65665242b8780107df403509a62a9e8a5924df5469f68?s=42&d=retro&r=g
createdAtdate-timerequired
The date and time when the notification was created
Example: 2022-12-02T13:17:12.445Z
readAtdate-timenullablerequired
The date and time when the notification was read or marked as read, otherwise null
Example: 2022-12-02T13:17:12.445Z
]

Example (auto)

[
  {
    "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: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!