Notification Endpoints

The Notifications family handles the lifecycle of user-facing events, read states, and delivery preferences.

List Notifications

Retrieve a paginated list of notifications for the authenticated user.

Use unreadOnly=false (the default) for all history, or unreadOnly=true for unread items. Other boolean strings are rejected. limit is 1–100; use offset to retrieve subsequent pages.

Reading an alert does not delete it, resolve its request, grant document access, or record a successful document view. It remains available in all history. The bell and history open safe internal destinations when supplied by the event; items without a supported destination remain available in notification history.

curl -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/v2/notifications?unreadOnly=true

{
"notifications": [
  {
    "id": "8f2349ef-22ab-46ae-a129-2eb4c2570001",
    "userId": "user_123",
    "type": "application_received",
    "title": "New Application",
    "body": "A new candidate has applied to your role.",
    "data": { "applicationId": "..." },
    "readAt": null,
    "createdAt": "2024-01-15T10:00:00Z"
  }
],
"totalCount": 1,
"unreadCount": 1,
"hasMore": false
}

Mark as Read

Mark a specific notification as read.

curl -X PUT -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/v2/notifications/8f2349ef.../read

Mark All Read

Mark all unread notifications for the current user as read.

curl -X PUT -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/v2/notifications/read-all

Digest Preferences

Manage your global email digest frequency and timing.

curl -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/v2/notifications/preferences/digest

Set Entity Preference

Mute or override digest frequency for a specific entity.

curl -X PUT \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"muted": true}' \
https://api.sureshake.com/v2/notifications/preferences/entity/8f2349ef...