Skip to content

Returns current user's settings including preferences and dashboard configuration

GET
/api/user/settings

Auto-generated from server.go. Handler: s.getUserSettings.

Successful response

Returns current user’s settings including preferences and dashboard configuration.

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/user/settings against the demo. Required fields are conservative — server returned all of them in the seed; relax to optional if some states legitimately omit.

object
loginTimeoutMinutes
required
integer
theme
required
string
autoRefresh
required
boolean
refreshInterval
required
integer
notification_auto_dismiss_seconds
required
integer
notification_show_details
required
boolean
dashboardStepMapping
required
object
1h
required
string
24h
required
string
30d
required
string
3h
required
string
timezone
required
string
dateFormat
required
string
timeFormat
required
string
systemIdleTimeoutMinutes
required
integer

Authentication is required or the supplied token is invalid.

Standardised error envelope per RFC 7807. Many existing endpoints still return an older shape (e.g. {"error": "..."}). This schema documents the target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the spec describes current behaviour without enforcing the migration here.

object
type

A URI reference that identifies the problem type.

string format: uri-reference
default: about:blank
title

A short human-readable summary of the problem.

string
status

The HTTP status code generated by the origin server.

integer format: int32
>= 100 <= 599
detail

A human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri-reference
error

Legacy error message field. Will be removed once handlers are migrated.

string
details

Legacy per-field error details. Will be removed once handlers are migrated.

object
key
additional properties
string
requestId

The request id middleware-assigned identifier for tracing.

string

Internal server error

Standardised error envelope per RFC 7807. Many existing endpoints still return an older shape (e.g. {"error": "..."}). This schema documents the target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the spec describes current behaviour without enforcing the migration here.

object
type

A URI reference that identifies the problem type.

string format: uri-reference
default: about:blank
title

A short human-readable summary of the problem.

string
status

The HTTP status code generated by the origin server.

integer format: int32
>= 100 <= 599
detail

A human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri-reference
error

Legacy error message field. Will be removed once handlers are migrated.

string
details

Legacy per-field error details. Will be removed once handlers are migrated.

object
key
additional properties
string
requestId

The request id middleware-assigned identifier for tracing.

string