Get all Comments for an Agent

GET

/api/v2/agents/{agent_id}/comments

Retrieves all comments for a specific agent.

Purpose:

Enables users to view all comments associated with a particular agent.

Path Parameters:

agent_id (int): Unique identifier of the agent to retrieve comments for.

Query Parameters:

user_id (int): Optional ID of the user to filter comments by.

Returns:

A JSON response with the serialized comment data if the comments are retrieved successfully.

A 404 Not Found error if the agent does not exist.

A 400 Bad Request error if the version is invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//comments?user_id=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "comments": [
            {
                "id": 0,
                "user": {
                    "id": 0,
                    "email": "[email protected]",
                    "is_staff": true,
                    "is_superuser": true,
                    "is_active": true,
                    "date_joined": "2019-08-24T14:15:22.123Z",
                    "first_name": "string",
                    "last_name": "string",
                    "organization": {
                        "id": 0,
                        "created_by": "string",
                        "modified_by": "string",
                        "created_on": "2019-08-24T14:15:22.123Z",
                        "modified_on": "2019-08-24T14:15:22.123Z",
                        "org_name": "string",
                        "domain": "string",
                        "description": "string",
                        "org_logo_url": "string",
                        "org_icon_url": "string",
                        "org_logo_url_dark": "string",
                        "org_icon_url_dark": "string",
                        "is_deleted": true,
                        "parent": 0
                    }
                },
                "comment": "string",
                "submit_date": "2019-08-24T14:15:22.123Z",
                "is_public": true,
                "is_removed": true,
                "agent": {
                    "id": 0,
                    "agent_name": "string"
                }
            }
        ]
    }
}

Agent Comment

Create a Comment