Skip to content

Returns the paginated list of members following this profile, each annotated with whether the current user follows them back.

Filter with search over display name and username; pass sort_by=alphabetical for name order, otherwise newest first. Blocked relationships are excluded.

Endpoint

  • Method: GET

  • Path: /profile/{username}/followers

  • Edition: PRO

  • Controller: FollowController@getFollowers

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

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

  • Requires FluentCommunity Pro with the followers_module feature enabled.

  • Visibility is governed by the followers privacy settings, so a restricted profile returns an error.

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 Followers

GET
/profile/{username}/followers

Returns the paginated list of members following this profile, each annotated with whether the current user follows them back.

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

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

Query Parameters

search

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

Type
string
sort_by

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

Type
string
Default
"id"

Responses

Successful response

application/json
JSON
{
  
"followers": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"created_at": "string",
  
  
  
  
"followed_id": "string",
  
  
  
  
"follower": {
  
  
  
  
  
"avatar": "string",
  
  
  
  
  
"badge": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"follow": "string",
  
  
  
  
  
"id": "string",
  
  
  
  
  
"is_follower": true,
  
  
  
  
  
"is_verified": 0,
  
  
  
  
  
"last_activity": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
  
"social_links": {
  
  
  
  
  
  
  
"instagram": "string",
  
  
  
  
  
  
  
"twitter": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"website": "string"
  
  
  
  
  
},
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
"short_description": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"total_points": 0,
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"username": "string"
  
  
  
  
},
  
  
  
  
"follower_id": "string",
  
  
  
  
"id": 0,
  
  
  
  
"level": "string",
  
  
  
  
"updated_at": "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
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation