Get Portal Configuration

Retrieve the full portal feature configuration for the current Nexudus location.

GET /api/public/configuration

Get Portal Configuration

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/configuration \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/configuration"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "[].Name": "<string>",
  "[].Value": "<string>",
  "401 Unauthorized": {},
  "404 Not Found": {}
}

Get Portal Configuration

Returns the complete portal configuration object for the current location. This includes feature flags, payment provider settings, branding configuration, checkout options, module availability, and all other operator-controlled settings that determine how the Members Portal behaves. The portal fetches this on startup and re-fetches when switching locations.

Authentication

Requires a valid customer bearer token, or returns public configuration for unauthenticated sessions depending on space settings.

Response

Returns BusinessSetting[] — a flat array of name–value pairs. Each setting corresponds to a portal configuration option set by the operator.

[].Name · string

The setting key (e.g. "PublicWebSite.Tour.TimeSlots.Enabled", "PaymentProvider", "AllowSelfSignup").

[].Value · string

The setting value as a string. Boolean settings use "True"/"False". Numeric settings are stringified.

Example Response

[
  { "Name": "PaymentProvider", "Value": "Stripe" },
  { "Name": "AllowSelfSignup", "Value": "True" },
  { "Name": "DefaultLanguage", "Value": "en" },
  { "Name": "PublicWebSite.Tour.TimeSlots.Enabled", "Value": "False" }
]

TypeScript Integration

import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'
import { BusinessSetting } from '@/types/sys/BusinessSetting'

const { resource: settings } = useData<BusinessSetting[]>(httpClient, endpoints.system.business.configuration)

const getSetting = (name: string) => settings?.find((x) => x.Name?.toLocaleLowerCase() === name.toLocaleLowerCase())?.Value

if (getSetting('AllowSelfSignup') === 'True') {
  // Show signup flow
}

Usage in Portal

Context	Source file
App bootstrap / feature flag provider	src/states/useLocationByRouteContext.tsx
Payment provider initialisation	src/views/checkout/
Navigation and route guard	src/routes/

Error Responses

401 Unauthorized · error

Authentication is required and no valid token was supplied.

404 Not Found · error

No configuration found for the resolved location.

Related Endpoints

Method	Endpoint	Description
GET	/api/public/businesses/current	Get the current location profile
GET	/api/sys/businesses/{id}/colors	Get the brand colour palette
GET	/api/public/outlines/navigation	Get the portal navigation outline