Search Settings

Searches portal settings by keyword.

GET /api/public/settings/search

Search Settings

cURL

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

import requests

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

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/settings/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "Settings": [
    {}
  ],
  "Settings[].Name": "<string>",
  "Settings[].Value": "<string>"
}

Search Settings

Searches the portal configuration settings by keyword. Returns matching setting name/value pairs.

Authentication

Requires a valid customer bearer token.

Query Parameters

searchTerm · string · required

Keyword to search for in setting names. URL-encoded.

Response

Settings · Setting[] · required

Array of matching settings.

Settings[].Name · string · required

Setting name/key.

Settings[].Value · string · required

Setting value.

TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: results } = useTypedData(httpClient, endpoints.settings.search('booking'))