VUZDevelopers

Get unread notification count

GET
/notifications/unread-count

Returns the count of unread notifications for the current user, optionally filtered by business.

Response includes:

  • total: Total unread count
  • byPriority: Breakdown by priority level
  • byCategory: Breakdown by category
  • hasCritical: Flag indicating if there are critical unread notifications

Use Cases:

  • Display badge count on notification bell
  • Show critical notification indicator
  • Dashboard notification summary

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Response Body

application/json

curl -X GET "https://example.com/notifications/unread-count"
{  "total": 19,  "byPriority": {    "low": 5,    "medium": 10,    "high": 3,    "critical": 1  },  "byBusiness": [    {      "businessId": "550e8400-e29b-41d4-a716-446655440000",      "businessName": "My Business Ltd",      "count": 15    }  ],  "byCategory": [    {      "category": "documents",      "count": 8    }  ],  "hasHighPriority": true,  "hasCritical": false}