Homarr
Users

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",  "byteUnitSystem": "binary",  "firstDayOfWeek": -9007199254740991,  "pingIconsEnabled": true,  "enableRightClickOnWidgets": true,  "headerPreferences": "string",  "defaultSearchEngineId": "string",  "openSearchInNewTab": true,  "ddgBangs": true,  "completedManageTour": true,  "completedBoardTour": true}

Search users

Find users whose names contain the query. Returns IDs, names, profile images, and email addresses, with up to 100 results. Requires admin permission.

Delete a user

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