Homarr
Users

Search users

POST/api/users/search

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

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.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/users/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
[  {    "id": "string",    "name": "string",    "image": "string",    "email": "string"  }]

List selectable users

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

Get a user

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