Skip to content

List Admin Users

Returns the paginated list of admin users — the back-office accounts that can sign in to the admin panel. Each row carries its assigned role (roleId / roleName) and active status.

The password and api_token values are never returned by any user operation.

Operation

OperationTypePurpose
adminSettingsUsersQueryCollectionList admin users with cursor pagination

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Users datagrid filters.

ArgumentTypeMatchExample
nameStringPartial (contains)."Admin"
emailStringPartial (contains)."@example.com"
role_idIntExact — the assigned role id.1
statusIntExact — 1 (active) or 0 (inactive).1

Sorting

ArgumentTypeValues
sortStringid (default), name, email
orderStringasc, desc (default desc)

Overview

For field meanings, create/update/delete rules, and delete guards, see the Users overview.

All admin endpoints require an admin Bearer token — see Authentication.

Released under the MIT License.