Skip to content

Returns the portal appearance settings — dark mode, header and sidebar behaviour, post modal, and the powered-by line.

Endpoint

  • Method: GET

  • Path: /settings/customization-settings

  • Edition: Core

  • Controller: SettingController@getCustomizationSettings

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

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

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

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 Customization Settings

GET
/settings/customization-settings

Returns the portal appearance settings — dark mode, header and sidebar behaviour, post modal, and the powered-by line.

Controller: SettingController@getCustomizationSettings
Route source: fluent-community/app/Http/Routes/api.php:159

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"settings": {
  
  
"a11y_enhancement_style": "string",
  
  
"affiliate_id": 0,
  
  
"collapse_sidebar_groups": "string",
  
  
"dark_mode": "string",
  
  
"default_feed_layout": "string",
  
  
"default_feed_sort_by": "string",
  
  
"default_theme_mode": "string",
  
  
"disable_feed_layout": "string",
  
  
"disable_feed_sort_by": "string",
  
  
"enable_sidebar_toggle": "string",
  
  
"feed_link_on_sidebar": "string",
  
  
"fixed_page_header": "string",
  
  
"fixed_sidebar": "string",
  
  
"hide_header_on_scroll": "string",
  
  
"icon_on_header_menu": "string",
  
  
"max_media_per_post": "string",
  
  
"member_list_layout": "string",
  
  
"post_title_pref": "string",
  
  
"rich_post_layout": "string",
  
  
"show_post_modal": "string",
  
  
"show_powered_by": "string"
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation