Skip to main content
GET
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Returns a page of a review’s findings, in document order. A finding is one check’s result, with its explanation, the text it relied on and any amendments it proposes. A check the reviewer switched off has no finding. Findings appear as checks complete, so a running review returns a partial list. Wait for the review’s operation to succeed before you act on the full set.

Authentication

Requires an API key, or an OAuth token with reviews:read.

Path parameters

string
required
The review id.

Query parameters

string
Only findings with this status: issue, ok, not_applicable or error. Pass issue to skip the checks that passed.
string
Only findings with this severity: high, medium or low. Only issues have a severity.
string
The cursor from the previous page. Omit it for the first page.
integer
default:"50"
Findings per page, from 1 to 200.

Response

Returns 200 with {"items": [...], "cursor": "..."}. cursor is null on the last page. Each item is a finding:
string
required
The finding’s id, which is its check’s id in this review. Pass it to Generate Redline.
string
required
The check’s name.
string
required
issue when the document fails the check, ok when it passes, not_applicable when the check did not apply, or error when the check could not run.
string | null
high, medium or low, set for issues.
string | null
Why, with reference to the playbook position or your instructions.
object[]
required
{ "file_id", "text" } for each passage relied on. file_id is one of the review’s file_ids, or null when the text comes from elsewhere.
object[]
required
The changes the check proposes, each { "id", "type", "preview" }. type is modification, insertion, deletion or comment, and preview is the change in Markdown. Empty when the check proposes none.

Errors