Function: getSettingsById()

getSettingsById<ThrowOnError>(options): RequestResult<GetSettingsByIdResponses, GetSettingsByIdErrors, ThrowOnError>

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

Retrieves a specific system setting by its unique identifier (name). The GetSetting endpoint provides a focused view of a single configuration parameter, allowing clients to fetch the value and metadata for a specific key. This is particularly useful for individual feature checks or targeted administrative updates, ensuring that setting data is accessible in a granular fashion while maintaining strict authorization checks.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetSettingsByIdData, ThrowOnError>

Returns

RequestResult<GetSettingsByIdResponses, GetSettingsByIdErrors, ThrowOnError>