Skip to content

Returns the post topics defined for the community, along with every space they can be attached to.

Pass optionsOnly for the trimmed id/title/description shape used by pickers; that variant also skips the space list. A search term filters topics by title, case-insensitively.

Endpoint

  • Method: GET

  • Path: /admin/topics

  • Edition: PRO

  • Controller: ProAdminController@getTopics

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

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

  • Requires a community admin, a course admin, or the admin role in the space named by space_id; course creators may call the optionsOnly variant.

  • Requires FluentCommunity Pro.

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 List Topics

GET
/admin/topics

Returns the post topics defined for the community, along with every space they can be attached to.

Controller: ProAdminController@getTopics
Route source: fluent-community-pro/app/Http/Routes/api.php:42

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Query Parameters

search

Search read via $request->getSafe() in getTopics().

Type
string

Responses

Successful response

application/json
JSON
{
  
"all_spaces": [
  
  
{
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"parent_id": "string",
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"course_type": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
}
  
],
  
"topics": [
  
  
{
  
  
  
"admin_only": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"slug": "string",
  
  
  
"space_ids": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"title": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation