Claim or unassign a review

Path parameters

Request body

application/json · ReviewAssignmentRequest · required

{
  "assignee": "me"
}

{
  "assignee": null
}

Responses

• 200 Updated assignment application/json

  • data Execution

    Schema: ExecutionDetail

    • id integer required
    • object string required
    • workflow_id integer required
    • status string required Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of queued pending running waiting awaiting_review completed failed cancelled skipped
    • execution_key string, nullable
    • external_reference string, nullable
    • needs_human_review boolean required
    • review_status string required One of none in_review approved denied
    • assigned_to_user_id integer, nullable The reviewer who claimed this execution, if any.
    • started_at string (date-time), nullable
    • completed_at string (date-time), nullable
    • created_at string (date-time) required
    • updated_at string (date-time), nullable
    • input_context object The payload originally sent at trigger time, plus resolved fields such as `execution_mode`, `submitted_by_user_id`, `user_approved`, `external_reference`, (for a test-mode run of a draft) `allow_inactive` and (for a test-mode run that replays a registered test subject) `sandbox_replay`.
  • meta Meta

    Schema: Meta

    • request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.

  200 exampleCopy

  {
    "data": {
      "id": 1842,
      "object": "execution",
      "workflow_id": 27,
      "status": "queued",
      "execution_key": "api_client:12:3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_reference": "rv-app-20491",
      "needs_human_review": true,
      "review_status": "none",
      "assigned_to_user_id": 1,
      "started_at": "2026-05-08T18:41:05Z",
      "completed_at": "2026-05-08T18:41:05Z",
      "created_at": "2026-05-08T18:41:05Z",
      "updated_at": "2026-05-08T18:41:05Z",
      "input_context": {}
    },
    "meta": {
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f"
    }
  }

• 401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

  Schema: ErrorEnvelope

  401 exampleCopy

  {
    "error": {
      "code": "unauthorized",
      "message": "A valid bearer token is required.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
    }
  }

• 403 Token does not hold the required scope. details lists the scope(s) that were checked. application/json

  Schema: ErrorEnvelope

  403 exampleCopy

  {
    "error": {
      "code": "insufficient_scope",
      "message": "This token does not have the required scope.",
      "details": [
        {
          "field": "scope",
          "message": "executions:write"
        }
      ],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope"
    }
  }

• 404 Resource does not exist or belongs to another tenant / api_client application/json

  Schema: ErrorEnvelope

  404 exampleCopy

  {
    "error": {
      "code": "not_found",
      "message": "The requested resource was not found.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/not_found"
    }
  }

• 422 validation_failed — assignee must be "me" or null application/json

  Schema: ErrorEnvelope

  422 exampleCopy

  {
    "error": {
      "code": "validation_failed",
      "message": "The request could not be processed.",
      "details": [
        {
          "field": "assignee",
          "message": "must be 'me' to claim or null to unassign"
        }
      ],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/validation_failed"
    }
  }

• 429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

  Schema: ErrorEnvelope

  429 exampleCopy

  {
    "error": {
      "code": "rate_limited",
      "message": "Rate limit exceeded. Retry later.",
      "details": [],
      "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
      "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
    }
  }

Related

• Human review — How a cascade pauses for a reviewer, what awaiting_review means for your integration, and the endpoints to claim, decide, note and audit reviews.
• Handle human review — Build a review queue on the API — find paused executions, claim them, approve or deny with a note, act in bulk, and reconcile with the audit trail.