Skip to main content

Review Assign

Assign a review item to a team member with POST /v1/review/:id/assign, or pass a null user_id to unassign. Distributes review workload across reviewers.

POST /v1/review/:id/assign sets the assignee on a review item, routing it to a specific team member's review workload. Assignments help distribute the queue and track who is responsible for each item. Pass null as the user_id to unassign an item and return it to the shared pool.

The user_id key must be present in the request body: send a user UUID to assign, or an explicit null to unassign. Omitting the key entirely fails validation.
POST/v1/review/:id/assign

Body parameters

user_id*string | nullUUID of the team member to assign. Pass null to unassign.

Response

Response fields

idstringReview record UUID.
run_idstringUUID of the run (Job or Pipeline run).
document_idstringUUID of the associated document.
schema_idstring | nullUUID of the schema used.
statusstringCurrent record status.
overall_confidencenumber | nullAggregate confidence score (0–1).
assigned_tostring | nullUUID of the newly assigned reviewer, or null if unassigned.
reviewed_bystring | nullUUID of the team member who last reviewed.
reviewed_atstring | nullISO 8601 timestamp of the last review action.
created_atstringISO 8601 creation timestamp.
linksobjectRelated resource URLs (self, action).

Response

{
  "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": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "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"
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundReview record not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Assignments are typically made after listing pending items via GET /v1/review and distributing them across team members. The assigned_to field appears in list and detail responses, so downstream tools can filter by assignee to build per-reviewer queues. Pass null as user_id to return an item to the unassigned pool.

Related

Get Review Item Detail
Approve or Reject an Item
List Review Items