Skip to content

Returns the server-rendered sidebar HTML together with the spaces the current user can act in, each carrying its resolved permissions, membership and topics.

Community moderators receive every space; everyone else receives only spaces where they hold an active membership. Private spaces the caller is not a member of come back with a lockscreen_config in place of content. The spaces map is keyed by slug.

Endpoint

  • Method: GET

  • Path: /options/sidebar-menu-html

  • Edition: Core

  • Controller: OptionController@getSidebarMenuHtml

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

  • Controller source: fluent-community/app/Http/Controllers/OptionController.php

  • Signed-out callers receive the rendered HTML and an empty spaces object.

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 Sidebar Menu HTML

GET
/options/sidebar-menu-html

Returns the server-rendered sidebar HTML together with the spaces the current user can act in, each carrying its resolved permissions, membership and topics.

Controller: OptionController@getSidebarMenuHtml
Route source: fluent-community/app/Http/Routes/api.php:149

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"auth_spaces": {
  
  
"__truncated__": "string",
  
  
"announcements": {
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"description_rendered": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"membership": {
  
  
  
  
"ID": "string",
  
  
  
  
"pivot": {
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"meta": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"role": "string",
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"parent_id": "string",
  
  
  
"permissions": {
  
  
  
  
"can_add_member": true,
  
  
  
  
"can_comment": true,
  
  
  
  
"can_create_post": true,
  
  
  
  
"can_remove_member": true,
  
  
  
  
"can_upload_documents": true,
  
  
  
  
"can_view_documents": true,
  
  
  
  
"can_view_info": true,
  
  
  
  
"can_view_media": true,
  
  
  
  
"can_view_members": true,
  
  
  
  
"can_view_posts": true,
  
  
  
  
"community_admin": true,
  
  
  
  
"community_moderator": true,
  
  
  
  
"delete_any_comment": true,
  
  
  
  
"delete_any_feed": true,
  
  
  
  
"edit_any_comment": true,
  
  
  
  
"edit_any_feed": true,
  
  
  
  
"is_member": true,
  
  
  
  
"read": true,
  
  
  
  
"registered": true,
  
  
  
  
"super_admin": true
  
  
  
},
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
"default_post_sort_by": "string",
  
  
  
  
"disable_layout_style": "string",
  
  
  
  
"disable_post_sort_by": "string",
  
  
  
  
"document_access": "string",
  
  
  
  
"document_library": "string",
  
  
  
  
"document_upload": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"media_access": "string",
  
  
  
  
"media_gallery": "string",
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_paywalls": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"topics": [
  
  
  
  
{
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
},
  
  
"general-discussion": {
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"description_rendered": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"membership": {
  
  
  
  
"ID": "string",
  
  
  
  
"pivot": {
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"meta": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"role": "string",
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"parent_id": "string",
  
  
  
"permissions": {
  
  
  
  
"can_add_member": true,
  
  
  
  
"can_comment": true,
  
  
  
  
"can_create_post": true,
  
  
  
  
"can_remove_member": true,
  
  
  
  
"can_upload_documents": true,
  
  
  
  
"can_view_documents": true,
  
  
  
  
"can_view_info": true,
  
  
  
  
"can_view_media": true,
  
  
  
  
"can_view_members": true,
  
  
  
  
"can_view_posts": true,
  
  
  
  
"community_admin": true,
  
  
  
  
"community_moderator": true,
  
  
  
  
"delete_any_comment": true,
  
  
  
  
"delete_any_feed": true,
  
  
  
  
"edit_any_comment": true,
  
  
  
  
"edit_any_feed": true,
  
  
  
  
"is_member": true,
  
  
  
  
"read": true,
  
  
  
  
"registered": true,
  
  
  
  
"super_admin": true
  
  
  
},
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
"default_post_sort_by": "string",
  
  
  
  
"disable_layout_style": "string",
  
  
  
  
"disable_post_sort_by": "string",
  
  
  
  
"document_access": "string",
  
  
  
  
"document_library": "string",
  
  
  
  
"document_upload": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"media_access": "string",
  
  
  
  
"media_gallery": "string",
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_paywalls": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"topics": [
  
  
  
  
{
  
  
  
  
  
"admin_only": "string",
  
  
  
  
  
"description": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"slug": "string",
  
  
  
  
  
"space_ids": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"title": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
}
  
},
  
"sidebar_html": "string"
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation