List site users

GET

/wp-json/wp2/site-manager/v1/sites/{blog_id}/users

curl --request GET \
  --url 'https://example.com/wp-json/wp2/site-manager/v1/sites/1/users?page=1&per_page=20' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Users attached to this blog (WP_User_Query with blog_id), with their first role on the site.

    Requires permission to manage the blog. Query `page` (default 1) and `per_page` (default 20, max 100).

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

blog_id

required

integer

Site ID in the current network (WP_Site->blog_id).

Query Parameters

page

integer

default: 1

Page number. PHP: max(1, page ?: 1).

per_page

integer

default: 20 <= 100

Users per page. PHP: max(1, min(100, per_page ?: 20)).

Responses

200

Page of site users (items, total, page, per_page).

Media typeapplication/json

object

items

Users of this blog (WP_User_Query with blog_id), one page.

Array<object>

object

user_id

WordPress user ID (WP_User->ID).

integer

login

Login (WP_User->user_login), not display_name.

string

email

Account email (WP_User->user_email).

string

role

User’s first role on this site ($user->roles[0]); empty string if none.

string

total

Total users on the site (WP_User_Query->get_total()), not the length of items.

integer

page

Page number after clamp (max(1, page)).

integer

per_page

Page size after clamp (max(1, min(100, per_page))).

integer

Example

{
  "items": [
    {
      "user_id": 14,
      "login": "editor.ivan",
      "email": "editor@example.com",
      "role": "editor"
    }
  ],
  "total": 3,
  "page": 1,
  "per_page": 20
}

401

Not authenticated. DualRest: rest_forbidden (status 401) when there is no cookie session. Cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

No permission on this blog (forbidden) or invalid REST nonce.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Site_not_in_network — site is not in the current network.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}