Skip to content

Returns the spaces a member actively belongs to, each with its member count.

Secret spaces are only included when the caller is the profile owner or a community moderator. Spaces with hide_members_count report zero unless the caller may view their members.

Endpoint

  • Method: GET

  • Path: /profile/{username}/spaces

  • Edition: Core

  • Controller: ProfileController@getSpaces

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

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

  • Gated by the user_space_visibility privacy setting; failure comes back carrying permission_failed.

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 Profile Spaces

GET
/profile/{username}/spaces

Returns the spaces a member actively belongs to, each with its member count.

Controller: ProfileController@getSpaces
Route source: fluent-community/app/Http/Routes/api.php:90

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

username*

Username extracted from the URL path.

Type
string
Required

Responses

Successful response

application/json
JSON
{
  
"spaces": [
  
  
{
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"members_count": 0,
  
  
  
"parent_id": "string",
  
  
  
"pivot": {
  
  
  
  
"created_at": "string",
  
  
  
  
"role": "string",
  
  
  
  
"space_id": "string",
  
  
  
  
"status": "string",
  
  
  
  
"user_id": "string"
  
  
  
},
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"emoji": "string",
  
  
  
  
  
  
"enabled": "string",
  
  
  
  
  
  
"new_tab": "string",
  
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
  
"slug": "string",
  
  
  
  
  
  
"title": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_fetured_image": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation