Skip to content

List Admin Users

EndpointMethod
/api/admin/settings/usersGET

Returns every admin user — the back-office accounts that can sign in to the admin panel — in the { data, meta } envelope. Each row carries its assigned role (roleId / roleName) and active status. The password and api_token values are never returned.

Pagination

ParameterDescription
pagePage number, 1-based. Default 1.
per_pageItems per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND. They mirror the admin Users datagrid filters.

ParameterMatchExample
namePartial (contains).?name=Admin
emailPartial (contains).[email protected]
role_idExact — the assigned role id.?role_id=1
statusExact — 1 (active) or 0 (inactive).?status=1

Sorting

ParameterValues
sortid (default), name, email
orderasc, desc (default desc)

Both the compound form ?sort=name-asc and the split form ?sort=name&order=asc are accepted.

Notes

  • status is 1 for an active admin (can sign in) and 0 for a deactivated one.
  • image is the stored relative avatar path; imageUrl is its fully-qualified public URL. Both are null for admins without an avatar.

See the Users overview for field meanings and behaviour.

Released under the MIT License.