Endpoint
- Method:
GET - Path:
/spaces/{spaceSlug}/by-slug - Edition: Core
- Controller:
SpaceController@getBySlug - Route source:
fluent-community/app/Http/Routes/api.php:9 - Controller source:
fluent-community/app/Http/Controllers/SpaceController.php
GET Get Space By Slug
GET
/spaces/{spaceSlug}/by-slug
Get Space By Slug for the FluentCommunity Spaces API.
Controller: SpaceController@getBySlug
Route source: fluent-community/app/Http/Routes/api.php:9
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
Requiredstring
Responses
Successful response
application/json
JSON "space": { "id": 0, "created_by": 0, "parent_id": 0, "title": "string", "slug": "string", "description": "string", "logo": "string", "cover_photo": "string", "type": "string", "privacy": "string", "status": "string", "serial": 0, "settings": { "restricted_post_only": "string", "emoji": "string", "shape_svg": "string", "custom_lock_screen": "string", "can_request_join": "string", "layout_style": "string", "disable_layout_style": "string", "show_sidebar": "string", "show_paywalls": "string", "og_image": "string", "links": [ { "title": "string", "enabled": "string", "new_tab": "string", "emoji": "string", "icon_image": "string", "shape_svg": "string", "permalink": "string", "slug": "string", "privacy": "string", "membership_ids": [ { "additionalProperties": "string" } ] } ], "document_library": "string", "document_access": "string", "disable_post_sort_by": "string", "default_post_sort_by": "string", "default_comment_sort_by": "string", "document_upload": "string", "topic_required": "string", "hide_members_count": "string", "onboard_redirect_url": "string", "members_page_status": "string", "cart_product_ids": [ 0 ] }, "created_at": "string", "updated_at": "string", "permissions": { "can_view_info": true, "can_view_posts": true, "can_view_members": true, "can_create_post": true }, "description_rendered": "string", "membership": { "ID": 0, "display_name": "string", "avatar": "string", "pivot": { "role": "string", "status": "string", "created_at": "string" } }, "topics": [ { "id": 0, "title": "string", "slug": "string" } ], "header_links": [ { "title": "string", "route": { "name": "string" } } ], "lockscreen_config": { "showCustom": true, "showPaywalls": true, "canSendRequest": true, "lockScreen": [ { "hidden": true, "type": "string", "label": "string", "name": "string", "heading": "string", "heading_color": "string", "description": "string", "text_color": "string", "button_text": "string", "button_link": "string", "button_color": "string", "button_text_color": "string", "background_image": "string", "overlay_color": "string", "new_tab": "string" } ], "redirect_url": "string" } }
{
}