Skip to content

List Users

GET /api/user

Required privilege: Users / View

Returns a paginated, filterable list of all user accounts.

Query Parameters

Parameter Description
filter Filter by any column key (see filterable fields below)
sort Sort column and direction
page / page_size Pagination

Filterable Fields

User Fullname · Username · User Phone · User Email · Role Name · User Status · 2FA Status

Response

{
  "data": {
    "headers": [
      { "key": "User Fullname", "format": "string" },
      { "key": "Username", "format": "string" },
      { "key": "User Email", "format": "string" },
      { "key": "Role Name", "format": "string" },
      { "key": "User Status", "format": "string" },
      { "key": "2FA Enabled", "format": "boolean" }
    ],
    "rows": [
      {
        "id": 12,
        "User Fullname": "Jane Doe",
        "Username": "jane.doe@acme.com",
        "User Email": "jane.doe@acme.com",
        "User Phone": "+1 555 000 0000",
        "Role Name": "Procurement Manager",
        "User Status": "Active",
        "2FA Enabled": true,
        "First Signin": false,
        "Password Expiration": "2025-06-01"
      }
    ]
  },
  "extra": { "page": 1, "page_size": 50, "total": 24 }
}

Code Examples

curl -b cookies.txt "https://acme.knosc.com/api/user"

response = session.get("https://acme.knosc.com/api/user")
users = response.json()["data"]["rows"]