Skip to content

Returns the email notification preferences for a member — the global toggles, the per-space post preferences grouped by space group, and the digest send day.

Preferences the member has never set are filled in from the community defaults, so the response is always complete. The per-space preference is flattened to all_member_posts, admin_only_posts or empty. Spaces with no parent group are gathered under a synthetic "Other Spaces" group.

Endpoint

  • Method: GET

  • Path: /profile/{username}/notification-preferences

  • Edition: Core

  • Controller: ProfileController@getNotificationPreferance

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

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

  • Requires the profile owner or a community moderator.

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 Get Notification Preferences

GET
/profile/{username}/notification-preferences

Returns the email notification preferences for a member — the global toggles, the per-space post preferences grouped by space group, and the digest send day.

Controller: ProfileController@getNotificationPreferance
Route source: fluent-community/app/Http/Routes/api.php:95

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

username*

Username extracted from the URL path.

Type
string
Required

Responses

Successful response

application/json
JSON
{
  
"default_messaging_email_frequency": "string",
  
"digestEmailDay": "string",
  
"spaceGroups": [
  
  
{
  
  
  
"id": 0,
  
  
  
"spaces": [
  
  
  
  
{
  
  
  
  
  
"icon": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"pref": "string",
  
  
  
  
  
"title": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"title": "string"
  
  
}
  
],
  
"space_prefs": {
  
  
"1": {
  
  
  
"np_by_admin_mail": "string",
  
  
  
"np_by_member_mail": "string"
  
  
},
  
  
"3": {
  
  
  
"np_by_admin_mail": "string",
  
  
  
"np_by_member_mail": "string"
  
  
},
  
  
"__truncated__": "string"
  
},
  
"user_globals": {
  
  
"com_my_post_mail": "string",
  
  
"digest_mail": "string",
  
  
"mention_mail": "string",
  
  
"message_email_frequency": "string",
  
  
"reply_my_com_mail": "string"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation