Skip to content

Endpoint

  • Method: GET
  • Path: /admin/welcome-banner
  • Edition: Core
  • Controller: AdminController@getWelcomeBannerSettings
  • Route source: fluent-community/app/Http/Routes/api.php:105
  • Controller source: fluent-community/app/Http/Controllers/AdminController.php

GET Get Admin Welcome Banner

GET
/admin/welcome-banner

Get Admin Welcome Banner for the FluentCommunity Admin API.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"settings": {
  
  
"login": {
  
  
  
"enabled": "string",
  
  
  
"mediaType": "string",
  
  
  
"bannerImage": "string",
  
  
  
"bannerVideo": {
  
  
  
  
"type": "string",
  
  
  
  
"url": "string",
  
  
  
  
"content_type": "string",
  
  
  
  
"provider": "string",
  
  
  
  
"title": "string",
  
  
  
  
"author_name": "string",
  
  
  
  
"html": "string"
  
  
  
},
  
  
  
"ctaButtons": [
  
  
  
  
{
  
  
  
  
  
"label": "string",
  
  
  
  
  
"link": "string",
  
  
  
  
  
"type": "string",
  
  
  
  
  
"newTab": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"description": "string",
  
  
  
"allowClose": "string"
  
  
},
  
  
"logout": {
  
  
  
"enabled": "string",
  
  
  
"mediaType": "string",
  
  
  
"bannerImage": "string",
  
  
  
"bannerVideo": {
  
  
  
  
"type": "string",
  
  
  
  
"url": "string",
  
  
  
  
"content_type": "string",
  
  
  
  
"provider": "string",
  
  
  
  
"title": "string",
  
  
  
  
"author_name": "string",
  
  
  
  
"html": "string"
  
  
  
},
  
  
  
"ctaButtons": [
  
  
  
  
{
  
  
  
  
  
"label": "string",
  
  
  
  
  
"link": "string",
  
  
  
  
  
"type": "string",
  
  
  
  
  
"newTab": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"description": "string",
  
  
  
"useCustomUrl": "string"
  
  
}
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation