Skip to content

Returns the paginated set of spaces the current user could join or already belongs to, each with its active member count.

Public and private spaces are always listed; secret spaces appear only where the user holds an active membership. Filter with search and type=joined; sort with sort_by set to alphabetical (the default), latest or oldest. Spaces with hide_members_count report zero unless the caller may view their members.

Endpoint

  • Method: GET
  • Path: /spaces/discover
  • Edition: Core
  • Controller: SpaceController@discover
  • Route source: fluent-community/app/Http/Routes/api.php:30
  • Controller source: fluent-community/app/Http/Controllers/SpaceController.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 Discover Spaces

GET
/spaces/discover

Returns the paginated set of spaces the current user could join or already belongs to, each with its active member count.

Controller: SpaceController@discover
Route source: fluent-community/app/Http/Routes/api.php:30

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Query Parameters

type

Type read via $request->getSafe() in discover().

Type
string
search

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

Type
string
sort_by

Sort By read via $request->getSafe() in discover().

Type
string
Default
"alphabetical"

Responses

Successful response

application/json
JSON
{
  
"execution_time": 0,
  
"spaces": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"cover_photo": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"created_by": "string",
  
  
  
  
"description": "string",
  
  
  
  
"description_rendered": "string",
  
  
  
  
"id": 0,
  
  
  
  
"logo": "string",
  
  
  
  
"members_count": 0,
  
  
  
  
"parent_id": "string",
  
  
  
  
"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": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"emoji": "string",
  
  
  
  
  
  
  
"enabled": "string",
  
  
  
  
  
  
  
"new_tab": "string",
  
  
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
  
  
"slug": "string",
  
  
  
  
  
  
  
"title": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"media_access": "string",
  
  
  
  
  
"media_gallery": "string",
  
  
  
  
  
"members_page_status": "string",
  
  
  
  
  
"og_image": "string",
  
  
  
  
  
"onboard_redirect_url": "string",
  
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
  
"shape_svg": "string",
  
  
  
  
  
"show_fetured_image": "string",
  
  
  
  
  
"show_paywalls": "string",
  
  
  
  
  
"show_sidebar": "string",
  
  
  
  
  
"topic_required": "string"
  
  
  
  
},
  
  
  
  
"slug": "string",
  
  
  
  
"space_pivot": {
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"meta": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"role": "string",
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": "string"
  
  
  
  
},
  
  
  
  
"status": "string",
  
  
  
  
"title": "string",
  
  
  
  
"type": "string",
  
  
  
  
"updated_at": "string"
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation