Get Agent Reviews

GET

/review/agent/{agent_id}

Agent APIs

Fetch reviews for agents, either all reviews or filtered by a specific agent with an optional limit.

Response Example

{
    "success": true,
    "message": "status code 200: Agent Reviews fetched successfully",
    "data": [
        {
            "id": 8,
            "created_by": "user1@example.com",
            "created_on": "2024-09-11T16:53:31.177325Z",
            "modified_by": "",
            "modified_on": "2024-09-11T16:53:31.177362Z",
            "user_review": "I am test review",
            "user": 3,
            "agent": 2
        },
        {
            "id": 11,
            "created_by": "user1@example.com",
            "created_on": "2024-09-16T14:26:31.340632Z",
            "modified_by": "user1@example.com",
            "modified_on": "2024-09-16T14:26:31.340673Z",
            "user_review": "I am test review 2",
            "user": 3,
            "agent": 3
        },
        {
            "id": 12,
            "created_by": "user1@example.com",
            "created_on": "2024-09-23T19:40:16.214536Z",
            "modified_by": "",
            "modified_on": "2024-09-23T19:40:16.214574Z",
            "user_review": "I am test review",
            "user": 3,
            "agent": 3
        }
    ]
}

Request

Path Params

agent_id

string

required

Query Params

agent_id

integer

optional

ID of the agent whose reviews are being fetched. If not provided, fetches reviews for all agents.

limit

integer

optional

Limit the number of reviews returned.

Responses

🟢200OK

application/json

Agent reviews fetched successfully.

Body

success

boolean

optional

Indicates if the request was successful.

message

string

optional

Status message.

data

array [object {8}]

optional

integer

optional

The ID of the review.

created_by

string

optional

The email of the user who created the review.

created_on

string <date-time>

optional

The timestamp when the review was created.

modified_by

string

optional

The email of the user who modified the review.

modified_on

string <date-time>

optional

The timestamp when the review was modified.

user_review

string

optional

The review content written by the user.

user

integer

optional

The ID of the user who wrote the review.

agent

integer

optional

The ID of the agent being reviewed.

Create a Review for an Agent

Update an Agent Review