BizKitHub
DocsAPI ReferenceAdmin/bff/admin/user-list
getAdminAdmin BFF

/bff/admin/user-list

Returns a paginated list of cas__user rows across the whole platform — not scoped to any organisation. Supports fulltext search (username / first name / last name / external id) and toggles for active/inactive, no-password, and 2FA-enabled. Each item carries derived counts of active memberships and pending invites so admins can tell at a glance who is onboarded and who is pending. Requires internal admin membership.

AdmingetBffAdminUser-list

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

16-char external id (wire form).

usernamestringRequired
firstNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
activebooleanRequired
hasOtpbooleanRequired

True when the user has a 2FA secret set.

hasPasswordbooleanRequired

False while the account is pending initial password setup.

avatarUrlstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastActivitystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
registerDatestringRequired
activeMembershipCountnumberRequired
pendingInviteCountnumberRequired
itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "username": "example_username",
      "active": false,
      "hasOtp": false,
      "hasPassword": false,
      "registerDate": "example_registerDate",
      "activeMembershipCount": 0,
      "pendingInviteCount": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/admin/user-list

get
curl -X GET "https://api.bizkithub.com/bff/admin/user-list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key