Skip to content

Endpoint

  • Method: GET
  • Path: /notifications
  • Edition: Core
  • Controller: NotificationsController@getNotifications
  • Route source: fluent-community/app/Http/Routes/api.php:127
  • Controller source: fluent-community/app/Http/Controllers/NotificationsController.php

GET List Notifications

GET
/notifications

List Notifications for the FluentCommunity Notifications API.

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

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": {
  
  
"data": [
  
  
  
{
  
  
  
  
"id": 0,
  
  
  
  
"feed_id": 0,
  
  
  
  
"object_id": 0,
  
  
  
  
"src_user_id": 0,
  
  
  
  
"src_object_type": "string",
  
  
  
  
"action": "string",
  
  
  
  
"route": {
  
  
  
  
  
"name": "string",
  
  
  
  
  
"params": {
  
  
  
  
  
  
"space": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"content": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"xprofile": {
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"username": "string",
  
  
  
  
  
"avatar": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"total_points": 0,
  
  
  
  
  
"is_verified": true,
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"website": "string",
  
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
  
"badge_slug": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"social_links": {
  
  
  
  
  
  
  
"instagram": "string",
  
  
  
  
  
  
  
"twitter": "string",
  
  
  
  
  
  
  
"youtube": "string",
  
  
  
  
  
  
  
"linkedin": "string",
  
  
  
  
  
  
  
"fb": "string",
  
  
  
  
  
  
  
"blue_sky": "string",
  
  
  
  
  
  
  
"tiktok": "string",
  
  
  
  
  
  
  
"pinterest": "string",
  
  
  
  
  
  
  
"telegram": "string",
  
  
  
  
  
  
  
"snapchat": "string",
  
  
  
  
  
  
  
"reddit": "string",
  
  
  
  
  
  
  
"twitch": "string",
  
  
  
  
  
  
  
"vk": "string",
  
  
  
  
  
  
  
"github": "string",
  
  
  
  
  
  
  
"mastodon": "string"
  
  
  
  
  
  
}
  
  
  
  
  
},
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"short_description": "string",
  
  
  
  
  
"last_activity": "string",
  
  
  
  
  
"badge": "string",
  
  
  
  
  
"permalink": "string"
  
  
  
  
},
  
  
  
  
"subscriber": {
  
  
  
  
  
"id": 0,
  
  
  
  
  
"object_id": 0,
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"is_read": true,
  
  
  
  
  
"object_type": "string",
  
  
  
  
  
"notification_type": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"updated_at": "string"
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"current_page": 0,
  
  
"per_page": 0,
  
  
"from": 0,
  
  
"to": 0,
  
  
"total": 0,
  
  
"last_page": 0,
  
  
"has_more": true
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation