Skip to main content
GET
/
api
/
public
/
settings
/
search
{
  "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'))