Skip to main content
GET
/
api
/
public
/
configuration
Get Portal Configuration
curl --request GET \
  --url https://spaces.nexudus.com/api/public/configuration \
  --header 'Authorization: Basic <encoded-value>'
{
  "[].Name": "<string>",
  "[].Value": "<string>",
  "401 Unauthorized": {},
  "404 Not Found": {}
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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

ContextSource file
App bootstrap / feature flag providersrc/states/useLocationByRouteContext.tsx
Payment provider initialisationsrc/views/checkout/
Navigation and route guardsrc/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.
MethodEndpointDescription
GET/api/public/businesses/currentGet the current location profile
GET/api/sys/businesses/{id}/colorsGet the brand colour palette
GET/api/public/outlines/navigationGet the portal navigation outline