Skip to main content

List Review Items

List pending review items in the review queue with pagination. Review items are validation records awaiting human approval, rejection, or flagging.

The review queue surfaces validation records that require human judgment before delivery. Items appear when extraction confidence is below the auto-approval threshold or when anomalies are detected.

GET/v1/review

Response

Response fields

dataarrayArray of review record objects.
data[].idstringReview record UUID.
data[].run_idstringUUID of the structuring run this record belongs to.
data[].document_idstringUUID of the associated document.
data[].schema_idstring | nullUUID of the schema used for this record.
data[].statusstringRecord status: pending, approved, or rejected.
data[].overall_confidencenumber | nullAggregate confidence score (0–1).
data[].assigned_tostring | nullUUID of the team member assigned to review this record.
data[].reviewed_bystring | nullUUID of the team member who last reviewed.
data[].reviewed_atstring | nullISO 8601 timestamp of the last review action.
data[].created_atstringISO 8601 creation timestamp.
data[].linksobjectRelated resource URLs (self, action).
pagination.totalintegerTotal number of records matching the query.
pagination.limitintegerMaximum results per page.
pagination.has_morebooleanWhether more results exist beyond this page.
pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "document_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "schema_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "status": "pending",
      "overall_confidence": 0.72,
      "assigned_to": null,
      "reviewed_by": null,
      "reviewed_at": null,
      "created_at": "2024-10-12T09:00:00.000Z",
      "links": {
        "self": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "action": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890/action"
      }
    }
  ],
  "pagination": {
    "total": 15,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.