Skip to content

Returns the paginated list of members this profile has blocked.

Endpoint

  • Method: GET

  • Path: /profile/{username}/blocked-users

  • Edition: PRO

  • Controller: FollowController@getBlockedUsers

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

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

  • Requires FluentCommunity Pro with the followers_module feature enabled.

  • Only the profile owner and community moderators may read this list; anyone else gets a 403.

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 Profile Blocked Users

GET
/profile/{username}/blocked-users

Returns the paginated list of members this profile has blocked.

Controller: FollowController@getBlockedUsers
Route source: fluent-community-pro/app/Http/Routes/api.php:130

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

username*

Username extracted from the URL path.

Type
string
Required

Responses

Successful response

application/json
JSON
{
  
"blockedUsers": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": "string",
  
  
"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": "string",
  
  
"total": 0
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation