Skip to content

Returns the paginated active membership of a space, each entry carrying the member profile and their role, plus the count of outstanding join requests.

Sort with sort_by set to created_at (join date, the default), display_name or last_activity, and sort_dir; filter with search. Callers who can add members may pass status=pending to list the join requests instead of the members.

Endpoint

  • Method: GET

  • Path: /spaces/{spaceSlug}/members

  • Edition: Core

  • Controller: SpaceController@getMembers

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

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

  • Gated by the can_view_members space permission; failure comes back as an error carrying permission_failed.

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 Space Members

GET
/spaces/{spaceSlug}/members

Returns the paginated active membership of a space, each entry carrying the member profile and their role, plus the count of outstanding join requests.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

spaceSlug*

SpaceSlug extracted from the URL path.

Type
string
Required

Query Parameters

search

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

Type
string
status

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

Type
string
sort_by

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

Type
string
Default
"created_at"
sort_dir

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

Type
string

Responses

Successful response

application/json
JSON
{
  
"members": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"created_at": "string",
  
  
  
  
"id": 0,
  
  
  
  
"meta": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"role": "string",
  
  
  
  
"space_id": "string",
  
  
  
  
"status": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"user_id": "string",
  
  
  
  
"xprofile": {
  
  
  
  
  
"avatar": "string",
  
  
  
  
  
"badge": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"is_verified": 0,
  
  
  
  
  
"last_activity": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"badge_slug": "string",
  
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
  
"social_links": {
  
  
  
  
  
  
  
"fb": "string",
  
  
  
  
  
  
  
"instagram": "string",
  
  
  
  
  
  
  
"linkedin": "string",
  
  
  
  
  
  
  
"twitter": "string",
  
  
  
  
  
  
  
"youtube": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"website": "string"
  
  
  
  
  
},
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
"short_description": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"total_points": 0,
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"username": "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
  
},
  
"pending_count": 0
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation