ForumNotificationsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| getAllForumNotifications | GET /community/notifications/all | Get all notifications for the logged-in user (paginated) |
| getUnreadForumNotifications | GET /community/notifications | Get unread notifications for the logged-in user (paginated) |
| markAllForumNotificationsAsRead | POST /community/notifications/mark-all-as-read | Mark all notifications as read for the logged-in user |
| markForumNotificationAsRead | POST /community/notifications/{notification_id}/mark-as-read | Mark a specific notification as read |
getAllForumNotifications
PaginatedResponse_NotificationResponse getAllForumNotifications(page, per_page)
Get all notifications for the logged-in user (paginated)
Retrieves complete notification history for the authenticated member, including both read and unread notifications. Provides full activity timeline for tracking community interactions.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of notifications per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_NotificationResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getUnreadForumNotifications
PaginatedResponse_NotificationResponse getUnreadForumNotifications(page, per_page)
Get unread notifications for the logged-in user (paginated)
Retrieves all unread community notifications for the authenticated member. Returns paginated list of pending notifications to keep members informed of new activity requiring their attention.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of notifications per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_NotificationResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
markAllForumNotificationsAsRead
EmptyResponse markAllForumNotificationsAsRead()
Mark all notifications as read for the logged-in user
Marks all pending notifications as read for the authenticated member in a single operation. Convenient for clearing notification backlog after reviewing activity.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
markForumNotificationAsRead
NotificationResponse markForumNotificationAsRead(notification_id)
Mark a specific notification as read
Marks an individual notification as read for the authenticated member. Verifies notification ownership before updating to ensure members can only manage their own notifications.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| notification_id | Long | ID of the notification to mark as read | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8