Homarr
Manage users and preferences

Get a user

GET/api/users/{userId}

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

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

userId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/users/string"
{  "id": "string",  "name": "string",  "email": "string",  "emailVerified": "string",  "image": "string",  "provider": "string",  "homeBoardId": "string",  "mobileHomeBoardId": "string",  "colorScheme": "string",  "byteUnitSystem": "binary",  "firstDayOfWeek": -9007199254740991,  "pingIconsEnabled": true,  "enableRightClickOnWidgets": true,  "headerPreferences": "string",  "defaultSearchEngineId": "string",  "openSearchInNewTab": true,  "ddgBangs": true,  "completedManageTour": true,  "completedBoardTour": true}

Update user 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.

Delete a user

Delete a user account. Users can delete themselves; deleting another user requires admin permission. Disabled in demo mode.