Search Users
Searches WordPress users by login, email or display name, for the guest picker.
Returns at most 50 users, by display name.
Endpoint
- Method:
GET - Path:
/fluent-event/v2/users - Controller:
UserController@getUsers - Route source:
fluent-event/app/Http/Routes/api.php:19 - Controller source:
fluent-event/app/Http/Controllers/UserController.php:9
Permissions
- Requires the
manage_optionscapability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.
Live sample
The request and response below were recorded on a running FluentEvent site and then anonymised. Names, emails and event titles are fictional, and long lists are cut to a few items.
Search Users
GET
/users
Searches WordPress users by login, email or display name, for the guest picker.
Controller: UserController@getUsers
Route source: fluent-event/app/Http/Routes/api.php:19
Authorizations
ApplicationPasswords
A WordPress username and an Application Password.
Type
HTTP (basic)
Parameters
Query Parameters
search
Matches login, email or display name.
Type
string
Example
"example.com"role_in
Comma-separated roles, for example subscriber,customer.
Type
string
Responses
Success
application/json
JSON "users": [ { "id": 0, "name": "string", "email": "string", "avatar": "string" } ]
{
}