API ReferenceEndpoints
Notification Endpoints
Manage in-app notifications and email digest preferences.
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.
GET
/api/v1/notificationscurl -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/api/v1/notifications?unreadOnly=true
200 OK
{
"data": [
{
"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"
}
],
"meta": {
"total": 1,
"limit": 20,
"offset": 0,
"hasMore": false
}
}Mark as Read
Mark a specific notification as read.
PATCH
/api/v1/notifications/:id/readcurl -X PATCH -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/api/v1/notifications/8f2349ef.../read
Mark All Read
Mark all unread notifications for the current user as read.
POST
/api/v1/notifications/read-allcurl -X POST -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/api/v1/notifications/read-all
Digest Preferences
Manage your global email digest frequency and timing.
GET
/api/v1/notifications/preferences/digestcurl -H "Authorization: Bearer $TOKEN" https://api.sureshake.com/api/v1/notifications/preferences/digest
Set Entity Preference
Mute or override digest frequency for a specific entity.
PUT
/api/v1/notifications/preferences/entity/:entityIdcurl -X PUT \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"muted": true}' \
https://api.sureshake.com/api/v1/notifications/preferences/entity/8f2349ef...