curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/reviews/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/reviews/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/reviews/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"_id": "6731f2c4d5e6f7a8b9c0d1e2",
"id": "6731f2c4d5e6f7a8b9c0d1e2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"type": "deal_update",
"kind": "action",
"origin": "model",
"status": "PENDING",
"approval": {
"status": "PENDING",
"by": null,
"at": null,
"comment": null,
"feedback": null
},
"agent": "Pipeline keeper",
"agentRef": {
"id": "6720a0b1c2d3e4f5a6b7c8da",
"name": "Pipeline keeper"
},
"runId": "1a2b3c4d5e6f708192a3b4c5d6e7f809",
"proposal": {
"title": "Update deal: Contoso expansion",
"summary": "Move the deal to Negotiation and raise the amount to 48,000.",
"args": {
"deal_id": "6730aa11bb22cc33dd44ee55",
"fields": {
"stage": "Negotiation",
"amount": 48000
}
}
},
"confidence": 64,
"reasoning": "Procurement confirmed the expanded seat count on the call.",
"approvalReason": "The stated confidence is below the workspace's threshold.",
"objectRef": {
"objectId": "6730aa11bb22cc33dd44ee55",
"objectType": "deals"
},
"objectRefs": [
{
"objectId": "6730aa11bb22cc33dd44ee55",
"objectType": "deals",
"name": "Contoso expansion"
}
],
"dealAction": "Update",
"previousVersion": {
"_id": "6730aa11bb22cc33dd44ee55",
"data": {
"deal_name": "Contoso expansion",
"stage": "Proposal",
"amount": 36000
},
"relationships": []
},
"newVersion": {
"_id": "6730aa11bb22cc33dd44ee55",
"data": {
"deal_name": "Contoso expansion",
"stage": "Negotiation",
"amount": 48000
},
"relationships": []
},
"relatedObjects": [
{
"_id": "6730aa11bb22cc33dd44ee55",
"objectType": "deals",
"data": {
"deal_name": "Contoso expansion",
"stage": "Proposal",
"amount": 36000
}
}
],
"previousVersionRelatedObjects": [],
"newVersionRelatedObjects": [],
"metadata": {
"created": {
"at": "2026-11-04T14:05:00.000Z"
},
"updated": {
"at": "2026-11-04T14:05:00.000Z"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Get a review
Returns one review with everything a person needs to decide it: the worker’s proposal (proposal, and the
type’s own fields such as draftEmail or previousVersion and newVersion), its reasoning, confidence
and approvalReason, the worker and run it came from (agentRef, runId), and the records it is about.
Unlike List reviews, the records and work the review refers to are resolved: relatedObjects holds the
company, people and deal records, interactionData the email thread or meeting, and taskData the task.
Once decided, approval holds the decision and outcome what happened.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/reviews/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/reviews/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/reviews/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"_id": "6731f2c4d5e6f7a8b9c0d1e2",
"id": "6731f2c4d5e6f7a8b9c0d1e2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"type": "deal_update",
"kind": "action",
"origin": "model",
"status": "PENDING",
"approval": {
"status": "PENDING",
"by": null,
"at": null,
"comment": null,
"feedback": null
},
"agent": "Pipeline keeper",
"agentRef": {
"id": "6720a0b1c2d3e4f5a6b7c8da",
"name": "Pipeline keeper"
},
"runId": "1a2b3c4d5e6f708192a3b4c5d6e7f809",
"proposal": {
"title": "Update deal: Contoso expansion",
"summary": "Move the deal to Negotiation and raise the amount to 48,000.",
"args": {
"deal_id": "6730aa11bb22cc33dd44ee55",
"fields": {
"stage": "Negotiation",
"amount": 48000
}
}
},
"confidence": 64,
"reasoning": "Procurement confirmed the expanded seat count on the call.",
"approvalReason": "The stated confidence is below the workspace's threshold.",
"objectRef": {
"objectId": "6730aa11bb22cc33dd44ee55",
"objectType": "deals"
},
"objectRefs": [
{
"objectId": "6730aa11bb22cc33dd44ee55",
"objectType": "deals",
"name": "Contoso expansion"
}
],
"dealAction": "Update",
"previousVersion": {
"_id": "6730aa11bb22cc33dd44ee55",
"data": {
"deal_name": "Contoso expansion",
"stage": "Proposal",
"amount": 36000
},
"relationships": []
},
"newVersion": {
"_id": "6730aa11bb22cc33dd44ee55",
"data": {
"deal_name": "Contoso expansion",
"stage": "Negotiation",
"amount": 48000
},
"relationships": []
},
"relatedObjects": [
{
"_id": "6730aa11bb22cc33dd44ee55",
"objectType": "deals",
"data": {
"deal_name": "Contoso expansion",
"stage": "Proposal",
"amount": 36000
}
}
],
"previousVersionRelatedObjects": [],
"newVersionRelatedObjects": [],
"metadata": {
"created": {
"at": "2026-11-04T14:05:00.000Z"
},
"updated": {
"at": "2026-11-04T14:05:00.000Z"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_reviews_get.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Path Parameters
The review's id.
^[0-9a-fA-F]{24}$Was this page helpful?

