Skip to content

Endpoint

  • Method: GET
  • Path: /members
  • Edition: Core
  • Controller: MembersController@getMembers
  • Route source: fluent-community/app/Http/Routes/api.php:122
  • Controller source: fluent-community/app/Http/Controllers/MembersController.php

GET List Members

GET
/members

List Members for the FluentCommunity Members API.

Controller: MembersController@getMembers
Route source: fluent-community/app/Http/Routes/api.php:122

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Query Parameters

mention

Mention read via $request->getSafe() in getMembers().

Type
string
space

Space read via $request->getSafe() in getMembers().

Type
string
space_id

Space ID read via $request->getSafe() in getMembers().

Type
string
sort_by

Sort By read via $request->getSafe() in getMembers().

Type
string
Default
"last_activity"
search

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

Type
string
status

Status read via $request->getSafe() in getMembers().

Type
string
Default
"active"

Responses

Successful response

application/json
JSON
{
  
"members": {
  
  
"data": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"current_page": 0,
  
  
"per_page": 0,
  
  
"from": 0,
  
  
"to": 0,
  
  
"total": 0,
  
  
"last_page": 0,
  
  
"has_more": true
  
},
  
"execution_time": 0
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation