Skip to content

Gets notifications data for the current user.

GET
/realms/{realm_id}/notifications

Gets notifications data for the current user, including pinned boards. If realm_id is present, also fetch notification data for the current realm.

realm_id
required
string format: uuid

The id of the realm.

The notifications data.

object
has_notifications
required
boolean
is_outdated_notifications
required
boolean
realm_id
required
string
realm_boards
required

A map from board id to its NotificationStatus for each realm board. If realm_id is not present in the params, it will be empty.

object
key
additional properties
object
id
required
string format: uuid
has_updates
required

Whether the board has a notification.

boolean
is_outdated
required

Whether the board’s notifications are older than the user’s last visit.

boolean
last_activity_at
required
One of:
string format: date-time
last_activity_from_others_at
required
One of:
string format: date-time
last_visited_at
required
One of:
string format: date-time
pinned_boards
required

A map from board id to its NotiicationStatus for each pinned board.

object
key
additional properties
object
id
required
string format: uuid
has_updates
required

Whether the board has a notification.

boolean
is_outdated
required

Whether the board’s notifications are older than the user’s last visit.

boolean
last_activity_at
required
One of:
string format: date-time
last_activity_from_others_at
required
One of:
string format: date-time
last_visited_at
required
One of:
string format: date-time

User was not found in request that requires authentication.

User is not authorized to perform the action.