Skip to content

Returns a paginated list of the comments one member has written, each with the full parent post eager-loaded so the post can open without a second request.

Despite living under the comments group this is a profile endpoint, addressed by {username}. Viewing another member list is restricted to posts that member can see and to plain text posts; the profile owner and community moderators see everything.

Endpoint

  • Method: GET
  • Path: /profile/{username}/comments
  • Edition: Core
  • Controller: ProfileController@getComments
  • Route source: fluent-community/app/Http/Routes/api.php:93
  • Controller source: fluent-community/app/Http/Controllers/ProfileController.php

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 Get Comments

GET
/profile/{username}/comments

Returns a paginated list of the comments one member has written, each with the full parent post eager-loaded so the post can open without a second request.

Controller: ProfileController@getComments
Route source: fluent-community/app/Http/Routes/api.php:93

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
{
  
"comments": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"content_type": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"id": 0,
  
  
  
  
"is_sticky": 0,
  
  
  
  
"message": "string",
  
  
  
  
"message_rendered": "string",
  
  
  
  
"meta": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"parent_id": "string",
  
  
  
  
"post": {
  
  
  
  
  
"comments": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"content_type": "string",
  
  
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
  
  
"id": 0,
  
  
  
  
  
  
  
"is_sticky": 0,
  
  
  
  
  
  
  
"message": "string",
  
  
  
  
  
  
  
"message_rendered": "string",
  
  
  
  
  
  
  
"meta": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"parent_id": "string",
  
  
  
  
  
  
  
"post_id": "string",
  
  
  
  
  
  
  
"reactions_count": "string",
  
  
  
  
  
  
  
"status": "string",
  
  
  
  
  
  
  
"type": "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"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"comments_count": 0,
  
  
  
  
  
"content_type": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
  
"featured_image": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"is_sticky": 0,
  
  
  
  
  
"message": "string",
  
  
  
  
  
"message_rendered": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"preview_data": "string"
  
  
  
  
  
},
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
"priority": 0,
  
  
  
  
  
"privacy": "string",
  
  
  
  
  
"reactions": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"reactions_count": 0,
  
  
  
  
  
"scheduled_at": "string",
  
  
  
  
  
"slug": "string",
  
  
  
  
  
"space": {
  
  
  
  
  
  
"id": 0,
  
  
  
  
  
  
"settings": {
  
  
  
  
  
  
  
"can_request_join": "string",
  
  
  
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
  
  
  
"default_post_sort_by": "string",
  
  
  
  
  
  
  
"disable_layout_style": "string",
  
  
  
  
  
  
  
"disable_post_sort_by": "string",
  
  
  
  
  
  
  
"document_access": "string",
  
  
  
  
  
  
  
"document_library": "string",
  
  
  
  
  
  
  
"document_upload": "string",
  
  
  
  
  
  
  
"emoji": "string",
  
  
  
  
  
  
  
"hide_members_count": "string",
  
  
  
  
  
  
  
"layout_style": "string",
  
  
  
  
  
  
  
"links": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"media_access": "string",
  
  
  
  
  
  
  
"media_gallery": "string",
  
  
  
  
  
  
  
"members_page_status": "string",
  
  
  
  
  
  
  
"og_image": "string",
  
  
  
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
  
  
  
"shape_svg": "string",
  
  
  
  
  
  
  
"show_paywalls": "string",
  
  
  
  
  
  
  
"show_sidebar": "string",
  
  
  
  
  
  
  
"topic_required": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"slug": "string",
  
  
  
  
  
  
"title": "string",
  
  
  
  
  
  
"type": "string"
  
  
  
  
  
},
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"terms": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"title": "string",
  
  
  
  
  
"type": "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"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"post_id": "string",
  
  
  
  
"reactions_count": "string",
  
  
  
  
"status": "string",
  
  
  
  
"type": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"user_id": "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
  
},
  
"xprofile": {
  
  
"avatar": "string",
  
  
"badge": "string",
  
  
"created_at": "string",
  
  
"display_name": "string",
  
  
"id": "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,
  
  
"updated_at": "string",
  
  
"user_id": 0,
  
  
"username": "string"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation