Searches WordPress users for the admin pickers, returning a paginated list matched on name, login and email.

Pass context=add_manager to exclude users who already hold a community role. On multisite the result is limited to users with capabilities on the current site.

Endpoint

• Method: GET

• Path: /admin/users

• Edition: PRO

• Controller: ProAdminController@getUsers

• Route source: fluent-community-pro/app/Http/Routes/api.php:13

• Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

• Requires the FluentCommunity community-admin permission (or a WordPress super admin).

• Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET Search Admin Users

GET

/admin/users

Searches WordPress users for the admin pickers, returning a paginated list matched on name, login and email.

Controller: ProAdminController@getUsers
Route source: fluent-community-pro/app/Http/Routes/api.php:13

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Parameters

Query Parameters

search

Search read via $request->getSafe() in getUsers().

Type

string

context

Context read via $request->get() in getUsers().

Type

string

Responses

Successful response

Content-Type

application/json

{

  

"users": {

  

  

"current_page": 0,

  

  

"data": [

  

  

  

{

  

  

  

  

"ID": 0,

  

  

  

  

"display_name": "string",

  

  

  

  

"photo": "string",

  

  

  

  

"user_email": "string",

  

  

  

  

"user_login": "string",

  

  

  

  

"user_nicename": "string",

  

  

  

  

"user_registered": "string",

  

  

  

  

"user_status": "string",

  

  

  

  

"user_url": "string"

  

  

  

}

  

  

],

  

  

"first_page_url": "string",

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"last_page_url": "string",

  

  

"links": [

  

  

  

{

  

  

  

  

"active": true,

  

  

  

  

"label": "string",

  

  

  

  

"url": "string"

  

  

  

}

  

  

],

  

  

"next_page_url": "string",

  

  

"path": "string",

  

  

"per_page": 0,

  

  

"prev_page_url": "string",

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/admin/users

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

search

context

Samples

Powered by VitePress OpenAPI