List Users

Retrieve a paginated list of all users

GET /api/admin/users

List All Users

curl -X GET "https://panel.example.com/api/admin/users?page=1&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "user-uuid-1",
      "username": "john.doe",
      "email": "[e-mail]",
      "name": "John Doe",
      "role": "user",
      "rootAdmin": false,
      "suspended": false,
      "emailVerified": true,
      "twoFactorEnabled": true,
      "passwordResetRequired": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "serversOwned": 3,
      "serversAccess": 3
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 50,
    "total": 150,
    "totalPages": 3
  }
}

Authentication

This endpoint requires admin authentication and the users:read permission.

Query Parameters

page · integer · default: "1"

Page number for pagination (minimum: 1)

limit · integer · default: "50"

Number of users per page (1-100)

search · string

Search by email or username (partial match)

Response

data · array

Array of user objects

Show User Object

id · string

User UUID

username · string

Username (falls back to email if not set)

email · string

User email address

name · string

Full name (first + last name)

role · string

User role: user or admin

rootAdmin · boolean

Whether the user has root admin privileges

suspended · boolean

Whether the user is suspended (banned)

emailVerified · boolean

Whether the email is verified

twoFactorEnabled · boolean

Whether 2FA/TOTP is enabled

passwordResetRequired · boolean

Whether user must reset password on next login

createdAt · string

ISO 8601 timestamp of account creation

serversOwned · integer

Number of servers owned by this user

serversAccess · integer

Number of servers user has access to

pagination · object

Pagination information

Show Pagination Object

page · integer

Current page number

perPage · integer

Users per page

total · integer

Total number of users

totalPages · integer

Total number of pages

List All Users

curl -X GET "https://panel.example.com/api/admin/users?page=1&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "user-uuid-1",
      "username": "john.doe",
      "email": "[e-mail]",
      "name": "John Doe",
      "role": "user",
      "rootAdmin": false,
      "suspended": false,
      "emailVerified": true,
      "twoFactorEnabled": true,
      "passwordResetRequired": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "serversOwned": 3,
      "serversAccess": 3
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 50,
    "total": 150,
    "totalPages": 3
  }
}

Notes

• Results are ordered by creation date (newest first)
• Search is case-insensitive and matches partial strings
• The serversOwned count is calculated via SQL query