Read one UI preference
const url = 'https://example.com/api/v1/ui-preferences?section_key=example&strict=false';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/ui-preferences?section_key=example&strict=false'Returns the preferred disclosure mode for a section key.
Missing persisted values are returned as default basic unless strict
is enabled.
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Canonical progressive disclosure section key
Canonical section key for progressive disclosure state
When true, missing rows return 404 instead of default response
Responses
Section titled “Responses”UI preference record
object
Canonical progressive disclosure section key
Disclosure visibility mode for the section
Example
{ "mode": "basic"}Invalid query parameter
object
Optional machine-readable error code, for example sync_in_progress or preview_stale
Examplegenerated
{ "error": "example", "code": "example"}Authentication required
object
Optional machine-readable error code, for example sync_in_progress or preview_stale
Examplegenerated
{ "error": "example", "code": "example"}Preference not found for strict read
object
Optional machine-readable error code, for example sync_in_progress or preview_stale
Examplegenerated
{ "error": "example", "code": "example"}Failed to read preference
object
Optional machine-readable error code, for example sync_in_progress or preview_stale
Examplegenerated
{ "error": "example", "code": "example"}