Skip to content

Returns the portal-wide settings record together with the list of WordPress roles that can be granted portal access and whether open registration is enabled on the site.

The administrator role is stripped from user_roles because administrators always have access. users_can_register reflects the WordPress option, not a FluentCommunity setting.

Endpoint

  • Method: GET

  • Path: /admin/general

  • Edition: Core

  • Controller: AdminController@getGeneralSettings

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

  • Controller source: fluent-community/app/Http/Controllers/AdminController.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 General Settings

GET
/admin/general

Returns the portal-wide settings record together with the list of WordPress roles that can be granted portal access and whether open registration is enabled on the site.

Controller: AdminController@getGeneralSettings
Route source: fluent-community/app/Http/Routes/api.php:100

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"settings": {
  
  
"access": {
  
  
  
"acess_level": "string"
  
  
},
  
  
"auth_content": "string",
  
  
"auth_form_type": "string",
  
  
"auth_redirect": "string",
  
  
"auth_url": "string",
  
  
"custom_signup_url": "string",
  
  
"cutsom_auth_url": "string",
  
  
"disable_global_posts": "string",
  
  
"explicit_registration": "string",
  
  
"featured_image": "string",
  
  
"is_slug_defined": true,
  
  
"logo": "string",
  
  
"logo_permalink": "string",
  
  
"logo_permalink_type": "string",
  
  
"notice_html": "string",
  
  
"restricted_role_content": "string",
  
  
"site_title": "string",
  
  
"slug": "string",
  
  
"use_custom_signup_page": "string",
  
  
"white_logo": "string"
  
},
  
"user_registration_enable_url": "string",
  
"user_roles": {
  
  
"author": "string",
  
  
"contributor": "string",
  
  
"editor": "string",
  
  
"subscriber": "string"
  
},
  
"users_can_register": true
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation