Get Notification Unread Count

Beta

GET/v1/messaging/notifications/unread-count

This endpoint is idempotent. Learn more

Returns the current user's unread tallies for the account they are acting in, for driving a notification badge.

The total also counts account announcements the user has not seen, so it can be higher than the notification count alone.

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

objectstringenumValues:notification_unread_count

Resource type identifier.

notificationsinteger

Number of the caller's notifications that have not been seen yet.

Dismissed notifications are never counted, and marking all notifications seen drops this to zero.

conversationsinteger

Number of conversations with unread messages.

Always 0 today — conversation unread counts are not yet folded into the bell.

totalinteger

Combined unread total for the bell badge.

This is the unseen notification count plus any account announcements the caller has not seen, so it can exceed notifications. Announcements are cleared individually rather than by marking all notifications seen.

Responses

200

Successful response for Get Notification Unread Count

Get Notification Unread Count

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationUnreadCount = await client.messaging.notifications.retrieveUnreadCount();

console.log(notificationUnreadCount.conversations);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationUnreadCount = await client.messaging.notifications.retrieveUnreadCount();

console.log(notificationUnreadCount.conversations);

200 example

{
  "object": "notification_unread_count",
  "notifications": 3,
  "conversations": 0,
  "total": 3
}

{
  "object": "notification_unread_count",
  "notifications": 3,
  "conversations": 0,
  "total": 3
}

Get Notification Unread Count

Authorization

Returns

Responses