Skip to content

Returns one space with its settings, topics, the current user membership and the permissions they hold inside it.

Endpoint

  • Method: GET

  • Path: /spaces/{spaceSlug}/by-slug

  • Edition: Core

  • Controller: SpaceController@getBySlug

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

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

  • A secret space the caller is neither a member nor an admin of returns exactly the same 404 as a space that does not exist, so its existence cannot be probed by slug.

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 Space By Slug

GET
/spaces/{spaceSlug}/by-slug

Returns one space with its settings, topics, the current user membership and the permissions they hold inside it.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

spaceSlug*

SpaceSlug extracted from the URL path.

Type
string
Required

Responses

Successful response

application/json
JSON
{
  
"space": {
  
  
"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",
  
  
"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",
  
  
  
"onboard_redirect_url": "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"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation