Read one UI preference

GET

/ui-preferences

curl --request GET \
  --url 'https://example.com/api/v1/ui-preferences?section_key=example&strict=false'

• API v1

Returns the preferred disclosure mode for a section key.

Missing persisted values are returned as default basic unless strict is enabled.

Parameters

Query Parameters

section_key

required

Canonical progressive disclosure section key

string

<= 96 characters /^[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+$/

Canonical section key for progressive disclosure state

strict

boolean

When true, missing rows return 404 instead of default response

Responses

200

UI preference record

Media typeapplication/json

object

section_key

required

Canonical progressive disclosure section key

string

<= 96 characters /^[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+$/

mode

required

Disclosure visibility mode for the section

string

Allowed values: basic advanced

updated_at

required

string format: date-time

nullable

persisted

required

boolean

Example

{
  "mode": "basic"
}

400

Invalid query parameter

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

404

Preference not found for strict read

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

500

Failed to read preference

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}