Skip to main content

Feed & Notifications

User activity feed and notification management. The feed aggregates activity for the user and every team they belong to.

GET /api/users/{username}/feed​

Get a user's activity feed, newest first: activity addressed to the user and to each team they belong to.

Authentication: Required

Permissions: A feed is personal. Only the user it belongs to and superusers can read it; anyone else gets 403. An unknown username answers 404.

Path Parameters:

ParameterTypeDescription
usernamestringUsername

Query Parameters:

ParameterTypeDefaultDescription
startinteger0Page index
sizeinteger30Items per page

Response:

A paginated HAL collection under _embedded["inf:feed-item"].

Get the activity feedGET /api/users/admin/feed?start=0&size=10
A paginated HAL collection of activity for the user and their teams, newest first. Page with start (page index) and size.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/users/admin/feed?start=0&size=10"
}
},
"start": 0,
"count": 0,
"total": 0,
"_embedded": {
"inf:feed-item": []
}
}
Captured from the API examples test suite; ids and timestamps are normalized.

Use Case:

Display the user's activity stream and notifications.


GET /api/users/{username}/feed-new-count​

Get the count of feed items since the user last marked the feed viewed.

Authentication: Required

Permissions: Only the user the feed belongs to and superusers; anyone else gets 403. An unknown username answers 404.

Response:

An object with a single count field.

Get the count of new feed itemsGET /api/users/admin/feed-new-count
Counts activity since the user last marked the feed viewed. Drives the notification badge.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/users/admin/feed-new-count"
}
},
"count": 0
}
Captured from the API examples test suite; ids and timestamps are normalized.

Use Case:

Display the notification badge count.


POST /api/users/{username}/_markFeedViewed​

Stamp the user's last-viewed time so the new-item count resets to zero. Takes no request body, and marks the entire feed viewed. A user can only mark their own feed, even while impersonating.

Authentication: Required

Mark the feed as viewedPOST /api/users/admin/_markFeedViewed
Stamps the user’s last-viewed time so the new-item count resets to zero. A user can only mark their own feed, even while impersonating.
Response · 200
[
1
]
Captured from the API examples test suite; ids and timestamps are normalized.

Use Case:

Clear the notification badge when the user opens their activity.