Returns the two portal welcome banner variants — one shown to signed-in members, one to logged-out visitors — as stored, before rendering.

Endpoint

• Method: GET

• Path: /admin/welcome-banner

• Edition: Core

• Controller: AdminController@getWelcomeBannerSettings

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

• 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 Admin Welcome Banner

GET

/admin/welcome-banner

Returns the two portal welcome banner variants — one shown to signed-in members, one to logged-out visitors — as stored, before rendering.

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

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": {

  

  

"login": {

  

  

  

"allowClose": "string",

  

  

  

"bannerImage": "string",

  

  

  

"bannerVideo": {

  

  

  

  

"author_name": "string",

  

  

  

  

"content_type": "string",

  

  

  

  

"html": "string",

  

  

  

  

"provider": "string",

  

  

  

  

"title": "string",

  

  

  

  

"type": "string",

  

  

  

  

"url": "string"

  

  

  

},

  

  

  

"ctaButtons": [

  

  

  

  

{

  

  

  

  

  

"label": "string",

  

  

  

  

  

"link": "string",

  

  

  

  

  

"newTab": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"description": "string",

  

  

  

"description_rendered": "string",

  

  

  

"enabled": "string",

  

  

  

"mediaType": "string",

  

  

  

"title": "string"

  

  

},

  

  

"logout": {

  

  

  

"bannerImage": "string",

  

  

  

"bannerVideo": {

  

  

  

  

"author_name": "string",

  

  

  

  

"content_type": "string",

  

  

  

  

"html": "string",

  

  

  

  

"provider": "string",

  

  

  

  

"title": "string",

  

  

  

  

"type": "string",

  

  

  

  

"url": "string"

  

  

  

},

  

  

  

"ctaButtons": [

  

  

  

  

{

  

  

  

  

  

"label": "string",

  

  

  

  

  

"link": "string",

  

  

  

  

  

"newTab": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"description": "string",

  

  

  

"description_rendered": "string",

  

  

  

"enabled": "string",

  

  

  

"mediaType": "string",

  

  

  

"title": "string"

  

  

}

  

}

}

GET

/admin/welcome-banner

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI