User Preferences Endpoint

The User Preferences Endpoint allows to manage the current user's preferences. It is available since 2025.16.

Global User Preferences

Create / Update a User Preference

PUT http://NUXEO_SERVER/nuxeo/api/v1/me/preferences/foo -d "bar"

{
  "entity-type": "userPreference",
  "key": "foo",
  "value": "bar"
}

Get all User Preferences

GET http://NUXEO_SERVER/nuxeo/api/v1/me/preferences

{
  "entity-type": "userPreferences",
  "preferences": {
    "foo": "bar",
    "anotherKey": "anotherValue"
  }
}

Get a single User Preference

GET http://NUXEO_SERVER/nuxeo/api/v1/me/preferences/foo

{
  "entity-type": "userPreference",
  "key": "foo",
  "value": "bar"
}

Delete a single User Preference

DELETE http://NUXEO_SERVER/nuxeo/api/v1/me/preferences/foo

Document User Preferences

The @preferences Document Adapter allows to manage per-document user preferences.

Create / Update document preferences

PUT http://NUXEO_SERVER/nuxeo/api/v1/path/{pathOfTheDoc}/@preferences

{
  "entity-type": "userPreferences",
  "preferences": {
    "key1": "value1",
    "key2": "value2"
  }
}

Get all document preferences

GET http://NUXEO_SERVER/nuxeo/api/v1/path/{pathOfTheDoc}/@preferences

Get a single document preference

GET http://NUXEO_SERVER/nuxeo/api/v1/path/{pathOfTheDoc}/@preferences/{preferenceKey}

Remove a single document preference

DELETE http://NUXEO_SERVER/nuxeo/api/v1/path/{pathOfTheDoc}/@preferences/{preferenceKey}

Delete all document preferences

DELETE http://NUXEO_SERVER/nuxeo/api/v1/path/{pathOfTheDoc}/@preferences

Configuration

The following nuxeo configuration properties are available:

• nuxeo.user.preferences.max defines the maximum number of preferences per user; the default is 2000
• nuxeo.user.preferences.sanitizeValues.enabled defines whether HTML sanitization is performed on preference values before persisting them; the default is true