Function: getSettings()

getSettings<ThrowOnError>(options?): RequestResult<GetSettingsResponses, GetSettingsErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:922

Retrieves a comprehensive list of all system settings. The GetSettings endpoint allows authorized administrators to fetch the entire collection of configuration parameters, providing a complete overview of the current system state. This endpoint is designed to facilitate administrative dashboards and auditing processes, ensuring that those with the appropriate permissions can review all active configuration keys and their associated values.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetSettingsData, ThrowOnError>

Returns

RequestResult<GetSettingsResponses, GetSettingsErrors, ThrowOnError>