Skip to main content
GET
/
api
/
v1
/
reviews
/
pending
List all pending reviews for a channel
curl --request GET \
  --url http://localhost:3001/api/v1/reviews/pending \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "clxyz111",
    "channelId": "clxyz456",
    "senderType": "agent",
    "senderId": "clxyz456",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "attachments": [
      {
        "id": "clxyz789",
        "messageId": "clxyz123",
        "pluginType": "file",
        "filename": "report.pdf",
        "mimeType": "application/pdf",
        "size": 1024,
        "storageKey": "uploads/clxyz123/report.pdf",
        "createdAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "text": "Hello from agent",
    "status": "info",
    "review": {
      "type": "approval",
      "status": "pending"
    },
    "metadata": {
      "source": "automation"
    }
  }
]

Authorizations

​
x-api-key
string
header
required

Placet API key (hp_...)

Query Parameters

​
channel
string
required

Channel (agent) ID

Response

List of messages with pending reviews

​
id
string
required
Example:

"clxyz111"

​
channelId
string
required
Example:

"clxyz456"

​
senderType
enum<string>
required
Available options:
agent,
user
Example:

"agent"

​
senderId
string
required
Example:

"clxyz456"

​
createdAt
string
required
Example:

"2025-01-01T00:00:00.000Z"

​
attachments
object[]
required
​
text
string
Example:

"Hello from agent"

​
status
enum<string>
Available options:
info,
success,
warning,
error
Example:

"info"

​
review
object

Review object (null if no review)

Example:
{ "type": "approval", "status": "pending" }
​
metadata
object

Arbitrary metadata

Example:
{ "source": "automation" }