Skip to content

Returns the lock screen configuration a space shows to visitors who are not members — its copy, imagery and call to action.

Endpoint

  • Method: GET

  • Path: /spaces/{spaceSlug}/lockscreens

  • Edition: Core

  • Controller: SpaceController@getLockScreenSettings

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

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

  • A secret space the caller is neither a member nor an admin of returns the same 404 as a space that does not exist.

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 Lockscreens

GET
/spaces/{spaceSlug}/lockscreens

Returns the lock screen configuration a space shows to visitors who are not members — its copy, imagery and call to action.

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

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
{
  
"lockscreen": [
  
  
{
  
  
  
"background_image": "string",
  
  
  
"button_color": "string",
  
  
  
"button_link": "string",
  
  
  
"button_text": "string",
  
  
  
"button_text_color": "string",
  
  
  
"description": "string",
  
  
  
"heading": "string",
  
  
  
"heading_color": "string",
  
  
  
"hidden": true,
  
  
  
"label": "string",
  
  
  
"name": "string",
  
  
  
"new_tab": "string",
  
  
  
"overlay_color": "string",
  
  
  
"text_color": "string",
  
  
  
"type": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation