Skip to content

Returns the paginated notification history for the current user, newest activity first, with the unread total alongside it.

Filter with status (for example unread) and notification_type, which defaults to all. Each row carries the actor profile and the per-user subscriber record that holds the read flag. Ordering is by updated_at, so a notification that gets new activity moves back to the top.

Endpoint

  • Method: GET

  • Path: /notifications

  • Edition: Core

  • Controller: NotificationsController@getNotifications

  • Route source: fluent-community/app/Http/Routes/api.php:131

  • Controller source: fluent-community/app/Http/Controllers/NotificationsController.php

  • Requires a signed-in user; a caller only ever sees their own notifications.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET List Notifications

GET
/notifications

Returns the paginated notification history for the current user, newest activity first, with the unread total alongside it.

Controller: NotificationsController@getNotifications
Route source: fluent-community/app/Http/Routes/api.php:131

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Parameters

Query Parameters

status

Status read via $request->get() in getNotifications().

Type
string
notification_type

Notification Type read via $request->get() in getNotifications().

Type
string
Default
"all"

Responses

Successful response

application/json
JSON
{
  
"notifications": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"action": "string",
  
  
  
  
"content": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"feed_id": "string",
  
  
  
  
"id": 0,
  
  
  
  
"object_id": "string",
  
  
  
  
"route": {
  
  
  
  
  
"name": "string",
  
  
  
  
  
"params": {
  
  
  
  
  
  
"feed_slug": "string",
  
  
  
  
  
  
"space": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"src_object_type": "string",
  
  
  
  
"src_user_id": "string",
  
  
  
  
"subscriber": {
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"is_read": "string",
  
  
  
  
  
"notification_type": "string",
  
  
  
  
  
"object_id": "string",
  
  
  
  
  
"object_type": "string",
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": "string"
  
  
  
  
},
  
  
  
  
"title": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"xprofile": "string"
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
},
  
"unread_count": 0
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation