Skip to main content
GET
Get a knowledge review item
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/knowledge/getReview?id=<itemId> returns one review item in the same shape as listReviews. It needs knowledge:read held at the deployment root. A malformed or missing id, an item outside the credential’s readable namespaces and a source-restricted item all answer 404 resource_missing, so a caller cannot tell them apart. A missing id parameter, or any other parameter, answers 400 bad_request. A pending item’s handoff.path opens the item in the Console review queue. A holder of knowledge:manage decides an item with POST /api/v2/knowledge/decideReview (MCP forge_decide_knowledge_review), or a person in Console through the item’s handoff link.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

reviewId
string
required

The review item id (id from listReviews).

Minimum string length: 1

Response

Review item

data
object
required

One knowledge review item in a namespace the caller may read: what waits for a person, why, and its case and related cases (each null-filled where the case has no value). Never names the reviewer, the reviewer's note, the assignee, the run or the decision. handoff is present exactly when status is pending: it is the Console path, where a person with knowledge:manage decides the item; a credential holding knowledge:manage decides it with POST /api/v2/knowledge/decideReview.

meta
object
required