User settings (settings)

Overview

Arbitrary application settings of the current user — a JSON object stored in the platform/users/Settings collection under the user identifier.
They are not interpreted by the server.

Requests

HTTP verb Endpoint Description

GET

/rest/v1/user/settings

Getting settings

PUT

/rest/v1/user/settings

Replacing settings

PATCH

/rest/v1/user/settings

Modifying settings

GET

/rest/v1/user/settings/<key>

Getting settings

PUT

/rest/v1/user/settings/<key>

Replacing settings

PATCH

/rest/v1/user/settings/<key>

Modifying settings

For all requests:
Domain type: any

Getting settings

Without <key>, returns the entire settings object ({} if there are no settings); the mask parameter is a comma-separated list of keys (or a JSON array) for selecting a part.
With <key>, returns the key value or null.

Example
GET /rest/v1/user/settings?mask=theme,layout HTTP/1.1

HTTP/1.1 200 OK

{"theme": "light", "layout": {"panel": "left"}}

Replacing settings

Without <key>, replaces the entire settings object (the body must be an object, otherwise 412).
With <key>, sets the key value (any JSON type); the value null removes the key.
Response: {"result": true}.

Modifying settings

Without <key>, merges the body object with the settings at the top level; keys with the value null are removed.
With <key>, likewise merges the body object with the key value (the key value must be an object, otherwise 412).
Response: {"result": true}.

Example
PATCH /rest/v1/user/settings/layout HTTP/1.1

{"panel": "right", "width": null}