Returns the general settings plus everything the setup wizard needs: which sibling Fluent plugins are already installed and the current user name and email to prefill.

Endpoint

• Method: GET

• Path: /admin/on-boardings

• Edition: Core

• Controller: AdminController@getOnBoardingSettings

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

• 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 Onboarding Settings

GET

/admin/on-boardings

Returns the general settings plus everything the setup wizard needs: which sibling Fluent plugins are already installed and the current user name and email to prefill.

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

Authorizations

ApplicationPasswords

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

Type

API Key (header: Authorization)

Responses

Successful response

Content-Type

application/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",

  

  

"has_fluentcart": "string",

  

  

"has_fluentcrm": "string",

  

  

"has_fluentsmtp": "string",

  

  

"install_fluentcart": "string",

  

  

"install_fluentcrm": "string",

  

  

"install_fluentsmtp": "string",

  

  

"is_slug_defined": true,

  

  

"logo": "string",

  

  

"logo_permalink": "string",

  

  

"logo_permalink_type": "string",

  

  

"notice_html": "string",

  

  

"restricted_role_content": "string",

  

  

"share_data": "string",

  

  

"site_title": "string",

  

  

"slug": "string",

  

  

"subscribe_to_newsletter": "string",

  

  

"template": "string",

  

  

"use_custom_signup_page": "string",

  

  

"user_email_address": "string",

  

  

"user_full_name": "string",

  

  

"white_logo": "string"

  

}

}

GET

/admin/on-boardings

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI