Appearance
Settings API
Read and update system-wide configuration. The GET endpoint is public. The PUT endpoint requires manage:settings permission.
Both endpoints work on four fields only: language, theme, supportEmail and dateFormat. The GET returns exactly these, and the PUT accepts exactly these; any other key in the request body is ignored. Everything else kept in the settings record — the seat policy and report, and on Enterprise the license status, instance ID and security policy — is internal and never returned or written through this API.
Get System Settings
Get system settings
GET
/v1/settings/system
Returns the public system settings: language, theme, support email and date format. No authentication is required, and nothing else from the settings record is ever included.
Authorizations
bearerAuth
JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.
Type
HTTP (bearer)
or
apiKeyAuth
API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.
Type
API Key (header: X-API-KEY)
Responses
Current system settings.
application/json
JSON "language": "en", "theme": "system", "dateFormat": "language"
{
}
Update System Settings
Update system settings
PUT
/v1/settings/system
Updates the public system settings. Only language, theme, supportEmail and dateFormat are accepted; any other key is ignored. Requires manage:settings permission.
Authorizations
bearerAuth
JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.
Type
HTTP (bearer)
or
apiKeyAuth
API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.
Type
API Key (header: X-API-KEY)
Request Body
application/json
JSON "language": "en", "theme": "system", "dateFormat": "language"
{
}
Responses
Updated system settings.
application/json
JSON "language": "en", "theme": "system", "dateFormat": "language"
{
}