Returns a paginated directory of community members in the requested sort order, or the trimmed candidate list the mention autocomplete uses.
Passing mention switches the endpoint into autocomplete mode: at most ten matches, the current user excluded, and — when space or space_id is given — restricted to that space, which the caller must belong to. The directory mode instead honours search, sort_by (last_activity, display_name or created_at) and sort_dir, and is gated by the members_page_status privacy setting.
Endpoint
Method:
GETPath:
/membersEdition: Core
Controller:
MembersController@getMembersRoute source:
fluent-community/app/Http/Routes/api.php:126Controller source:
fluent-community/app/Http/Controllers/MembersController.phpModerators may pass
statusto listpending,blockedordeactivatedmembers; everyone else only ever sees active profiles.When the members page is restricted the response is an error carrying
permission_failed, not an empty list.
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 List Members
Returns a paginated directory of community members in the requested sort order, or the trimmed candidate list the mention autocomplete uses.
Controller: MembersController@getMembers
Route source: fluent-community/app/Http/Routes/api.php:126
Authorizations
WordPress Application Passwords — use Basic auth with username:application_password.
Parameters
Query Parameters
Mention read via $request->getSafe() in getMembers().
Space read via $request->getSafe() in getMembers().
Space ID read via $request->getSafe() in getMembers().
Sort By read via $request->getSafe() in getMembers().
"last_activity"Sort Dir read via $request->getSafe() in getMembers().
Search read via $request->getSafe() in getMembers().
Status read via $request->getSafe() in getMembers().
"active"Responses
Successful response