Retrieve a User's Comments API

Edit on GitHubView Markdown
On this page

This API is used to retrieve all of the User Comments on a User's account. User Comments are used to allow administrators and moderators the ability to take notes on Users.

Request#

API Key Authentication
Retrieve all Comments for a User by Id
GET/api/user/comment/{userId}
OpenAPI Spec

Request Headers#

X-FusionAuth-TenantId
  • Type: String
  • Optional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon other values in the request or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Path Parameters#

userId
  • Type: UUID
  • Required

The Id of the User to retrieve the User Comments for.

Response#

The response for this API contains all of the User Comments for the User.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

userComments
  • Type: Array

The list of User Comment objects.

userComments[x].comment
  • Type: String

The text of the User Comment.

userComments[x].commenterId
  • Type: UUID

The Id of the User that wrote the User Comment.

userComments[x].createInstant
  • Type: Long
  • Deprecated

The instant when the comment was written. This was deprecated in 1.18.0. Use insertInstant instead.

userComments[x].id
  • Type: UUID

The Id of the User Comment.

userComments[x].insertInstant
  • Type: Long

The instant when the comment was written.

userComments[x].userId
  • Type: UUID

The Id of the User that the User Comment was written for.

Example Response JSON
{
  "userComments": [
    {
      "comment": "Not sure if this user is violating any rules or not.",
      "commenterId": "00000000-0000-0000-0000-000000000002",
      "id": "00000000-0000-0000-0000-000000000042",
      "insertInstant": 1471786483322,
      "userId": "00000000-0000-0000-0000-000000000003"
    }
  ]
}

Related

APIs

Add a Comment to a User API

API documentation for the FusionAuth Add a Comment to a User API.

fusionauth apirest apihttp api
APIs

User Comment API

Learn about the APIs for creating and retrieving comments on users.

fusionauth apirest apihttp api
APIs

Search for User Comments API

API documentation for the FusionAuth Search for User Comments API.

fusionauth apirest apihttp api
APIs

User Action API

Learn about the APIs for invoking a User Action on a User.

fusionauth apirest apihttp api