Homarr
Users

List selectable users

GET/api/users/selectable

Return user IDs, names, profile images, and email addresses for selection controls, optionally filtered by authentication provider. Requires authentication.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Query Parameters

providers?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/users/selectable"
[  {    "id": "string",    "name": "string",    "image": "string",    "email": "string"  }]

Set a profile image

Set a user's image to a base64 PNG, JPEG, GIF, or WebP data URL, or null to clear it. The data URL is limited to 350,000 characters. Users can update themselves; updating another user requires admin permission.

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.