Get Notifications list

Retrieve authenticated user’s Notifications.

GET /api/v1/notifications

Try it

cURL

cURL

curl --request GET \
  --url https://app.aegister.com/api/v1/notifications \
  --header 'X-Aegister-Token: <api-key>'

200

{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": 123,
      "organization": {
        "id": 123,
        "name": "<string>",
        "logo": "<string>"
      },
      "title": "<string>",
      "message": "<string>",
      "type": "info",
      "action": "link",
      "read": true,
      "datetime": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "extra": {
        "href": "<string>"
      }
    }
  ]
}

Authorizations

X-Aegister-Token · string · header · required

Response

200 - application/json

error · integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

messages · array

If error is 1, contains zero or more details on the error.

total · number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0

data · object[]

Show child attributes

data. id · number

Unique identifier for the notification.

data. organization · object

Show child attributes

data.organization. id · number

Unique identifier for the Organization.

data.organization. name · string

Organization common name.

data.organization. logo · string<uri>

Organization logo URL.

data. title · string

Subject of the notification.

data. message · string

Content of the notification.

data. type · enum<string>

Specify the level of priority of the notification

Available options: info, warning

data. action · enum<string>

The notification action type.

Available options: link

data. read · boolean

Specify if the notification has been read.

data. datetime · string<date-time>

Timestamp of creation of the notification.

data. icon · string

Notification icon classes.
Classes are defined in FontAwesome.

data. extra · object

Extra informations and details of the notification.

Show child attributes

data.extra. href · string<uri-relative>

Redirect page on action.