Get Notifications list

Retrieve authenticated user’s Notifications.

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

Example:

0

messages

any[]

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

Example:

[]

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

Example:

20

data

object[]

Show child attributes

data.id

number

Unique identifier for the notification.

Example:

11

data.organization

object

Show child attributes

data.organization.id

number

Unique identifier for the Organization.

Example:

5

data.organization.name

string

Organization common name.

Example:

"Sample Organization"

data.organization.logo

string

Organization logo URL.

Example:

"https://sample.com/logo.svg"

data.title

string

Subject of the notification.

Example:

"Subscription payment"

data.message

string

Content of the notification.

Example:

"The active subscription has been canceled."

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.

Example:

true

data.datetime

string

Timestamp of creation of the notification.

data.icon

string

Notification icon classes.
Classes are defined in FontAwesome.

Example:

"fa-solid fa-circle-info"

data.extra

object

Extra informations and details of the notification.

Show child attributes

data.extra.href

string

Redirect page on action.

Example:

"/organizations/edit/1#subscriptions"