Homarr
Manage users and preferences

Update user preferences

PATCH/api/users/preferences

Update only supplied preferences and return the result. Omitted fields remain unchanged; null clears nullable references. Header fields and zones merge, while each supplied zone array replaces that zone. The complete merged header must retain unique items and account access. New board shortcuts must be accessible to the target user. Omit userId for yourself; another user requires admin permission. All validation completes before one write.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/users/preferences" \  -H "Content-Type: application/json" \  -d '{    "colorScheme": "light"  }'
{  "colorScheme": "auto",  "byteUnitSystem": "binary",  "firstDayOfWeek": 0,  "pingIconsEnabled": true,  "enableRightClickOnWidgets": true,  "homeBoardId": "string",  "mobileHomeBoardId": "string",  "defaultSearchEngineId": "string",  "openSearchInNewTab": true,  "ddgBangs": true,  "headerPreferences": {    "version": 3,    "visible": true,    "searchDisplay": "input",    "logoDisplay": "logo",    "zones": {      "left": [        {          "type": "builtin",          "id": "logo"        }      ],      "center": [        {          "type": "builtin",          "id": "logo"        }      ],      "right": [        {          "type": "builtin",          "id": "logo"        }      ]    }  },  "userId": "string"}

Get user preferences

Read every preference as structured JSON. Omit userId for the current user; reading another user requires admin permission.

Get a user

Return a user's profile, authentication provider, and preferences. Users can read themselves; reading another user requires admin permission.