Skip to content

Returns the space groups with their spaces expanded, plus any space or course that has not been assigned to a group.

Pass options_only for the trimmed id and title list used by pickers, which any portal user may read. The full response formats each community space for the caller and attaches topics to courses, so it is considerably heavier.

Endpoint

  • Method: GET

  • Path: /spaces/space_groups

  • Edition: Core

  • Controller: SpaceController@getSpaceGroups

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

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

  • The full listing requires community-admin or course-admin access, or the admin role in the space named by space_id.

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 Space Groups

GET
/spaces/space_groups

Returns the space groups with their spaces expanded, plus any space or course that has not been assigned to a group.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Query Parameters

options_only

Options Only read via $request->get() in getSpaceGroups().

Type
string

Responses

Successful response

application/json
JSON
{
  
"groups": [
  
  
{
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"parent_id": "string",
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"always_show_spaces": "string",
  
  
  
  
"hide_members": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"spaces": [
  
  
  
  
{
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"created_by": "string",
  
  
  
  
  
"description": "string",
  
  
  
  
  
"description_rendered": "string",
  
  
  
  
  
"header_links": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"route": {
  
  
  
  
  
  
  
  
"name": "string"
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
"title": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"id": 0,
  
  
  
  
  
"logo": "string",
  
  
  
  
  
"membership": {
  
  
  
  
  
  
"ID": 0,
  
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
  
"photo": "string",
  
  
  
  
  
  
"pivot": {
  
  
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
  
  
"role": "string",
  
  
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
  
  
"status": "string",
  
  
  
  
  
  
  
"user_id": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"user_email": "string",
  
  
  
  
  
  
"user_login": "string",
  
  
  
  
  
  
"user_nicename": "string",
  
  
  
  
  
  
"user_registered": "string",
  
  
  
  
  
  
"user_status": "string",
  
  
  
  
  
  
"user_url": "string"
  
  
  
  
  
},
  
  
  
  
  
"parent_id": "string",
  
  
  
  
  
"permalink": "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_post_sort_by": "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"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"members_page_status": "string",
  
  
  
  
  
  
"og_image": "string",
  
  
  
  
  
  
"onboard_redirect_url": "string",
  
  
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
  
  
"shape_svg": "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"
  
  
  
  
}
  
  
  
],
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
}
  
],
  
"orphaned_spaces": [
  
  
{
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"parent_id": "string",
  
  
  
"permalink": "string",
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"course_details": "string",
  
  
  
  
"course_layout": "string",
  
  
  
  
"course_type": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"disable_comments": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_instructor_view": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"public_lesson_view": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"sequential_lesson_order": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_instructor_students_count": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"topics": [
  
  
  
  
{
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation