Homarr
Users

List all users

GET/api/users

Return user IDs, names, email addresses, verification dates, and profile images. Requires admin permission.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Response Body

application/json

application/json

application/json

application/json

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

Update global board settings

Update supplied instance board defaults and return the resulting settings. Home board IDs must reference public boards, or be null to clear the default. Requires admin permission.

Create a user

Create a credentials account and assign the supplied groups. Requires admin permission and credentials authentication to be enabled. The username must be unique and password confirmation must match.