List Users - Plugixa Advanced User Role Editor for WordPress

List Users - Plugixa Advanced User Role Editor

GET /plugixa-aure/v1/users

A page of accounts with their roles and the capabilities set on each account itself, sorted by display name.

Needs the Edit people permission: plugixa_aure_edit_users. Part of the Users feature: when it is switched off in Settings the route is not registered and answers 404.

Note. Every row includes the account’s e-mail address.

Request

GET https://your-site.example/wp-json/plugixa-aure/v1/users?role=editor&search=mar

Query parameters

Name	Type	Default	Description
`page`	`integer`	`1`	Page to return, from 1.
`per_page`	`integer`	`25`	Rows per page, 1 to 100.
`search`	`string`		Accounts whose login, e-mail, nicename or display name starts with the term.
`role`	`string`		Only accounts holding this role.

The totals come inside data, not in headers or meta. See Lists and pagination.

Responses

`200` OK. `data` is one page of accounts.

{
  "success": true,
  "data": {
    "items": [
      {
        "id": 12,
        "login": "maria",
        "name": "Maria Lopez",
        "email": "maria@example.com",
        "roles": [
          "author"
        ],
        "overrides": 1,
        "version": "a41d07c95e22",
        "caps": {
          "upload_files": false
        },
        "registered": "2026-03-04T08:12:45Z",
        "superAdmin": false,
        "editable": true,
        "avatar": "https://secure.gravatar.com/avatar/0f1e2d3c4b5a?s=48&d=mm&r=g"
      }
    ],
    "total": 1,
    "pages": 1
  }
}

Field	Type	Meaning
`data.items[]`	`array`	Accounts, with the fields of `data.user` in Get User
`data.total`	`integer`	Accounts matching, before paging
`data.pages`	`integer`	Number of pages at this `per_page`

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-aure/v1/users?role=editor&search=mar" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'role'   => 'editor',
    'search' => 'mar',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-aure/v1/users?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const query = new URLSearchParams({ role: 'editor', search: 'mar' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-aure/v1/users?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();