Skip to content

Returns the welcome banner for the current audience — the signed-in variant for members, the logged-out variant for visitors.

Endpoint

  • Method: GET
  • Path: /feeds/welcome-banner
  • Edition: Core
  • Controller: FeedsController@getWelcomeBanner
  • Route source: fluent-community/app/Http/Routes/api.php:73
  • Controller source: fluent-community/app/Http/Controllers/FeedsController.php

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

GET
/feeds/welcome-banner

Returns the welcome banner for the current audience — the signed-in variant for members, the logged-out variant for visitors.

Controller: FeedsController@getWelcomeBanner
Route source: fluent-community/app/Http/Routes/api.php:73

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"welcome_banner": {
  
  
"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_rendered": "string",
  
  
"enabled": "string",
  
  
"mediaType": "string",
  
  
"title": "string"
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation