---
title: "Get a worksheet's review changes given a worksheet ID"
method: GET
path: "/worksheets/{worksheet_id}/review-changes"
tags: ["worksheets"]
---

# Get a worksheet's review changes given a worksheet ID

`GET /worksheets/{worksheet_id}/review-changes`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/worksheets/{worksheet_id}/review-changes`
- Auth: HTTP bearer

Get a worksheet's review changes given a worksheet ID

## Path parameters

- `worksheet_id` string, required

## Query parameters

- `returning` string

## Response `200`

Returns a single worksheet's basic metadata along with its review changes, including any snapshot information if present.

- WorksheetReviewChangesById
  - `worksheet` WorksheetReviewChanges: Contents include basic worksheet metadata along with its review changes, including any snapshot information if present.
    - `apiURL` string, uri, nullable: The canonical url of the Worksheet's review history in the API.
    - `createdAt` string, date-time: DateTime the worksheet was created at
    - `creator` UserSummary
      - `handle` string
      - `id` string
      - `name` string
    - `folderId` string: ID of the folder that contains the worksheet
    - `id` string: ID of the worksheet
    - `modifiedAt` string: DateTime the worksheet was last modified
    - `name` string: Title of the worksheet
    - `reviewRecord` WorksheetReviewChangesReviewRecord: Review record if set
      - `comment` string: Reviewer's Comments
      - `reviewChanges` ReviewChange[]: A list of the Review Changes that have been made to this worksheet
        - `action` 'SEND_FOR_REVIEW' | 'ACCEPT' | 'REJECT' | 'COMMENT' | 'RETRACT': The action which was performed with this change
        - `comment` string, nullable: The comment which was left when the Review Change was submitted
        - `createdAt` string, date-time: DateTime the Review Change was created at
        - `esigned` boolean: Was the action verified through an e-signature compliant step
        - `id` string
        - `reviewSnapshot` ReviewSnapshot
          - `createdAt` string, date-time: DateTime the Review Snapshot was created at
          - `downloadURL` string: A short-lived URL that can be used to download the original file.
          - `expiresAt` string, date-time: DateTime the downloadURL expires.
          - `size` integer: Size, in bytes, of the snapshot file
          - `status` 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED': the current status of the Snapshot process
      - `reviewProcesses` EntryReviewProcess[], nullable: Review Processes associated with the Worksheet
        - `completionStatus` 'APPROVED' | 'COMPLETED' | 'ACCEPTED' | 'REVIEWED' | 'WITNESSED' | 'SELF_REVIEWED': State of the Entry at the end of the Review Process
        - `id` string: ID of the Review Process
        - `name` string: Name of the Review Process
        - `stages` EntryReviewProcessStagesItems[]: Array of Stages for the Review Process
          - `actionLabel` 'APPROVE' | 'COMPLETE' | 'ACCEPT' | 'REVIEW' | 'WITNESS' | 'SELF_REVIEW': Action reviewer is doing during the review
          - `id` string: ID of the Review Stage
          - `name` string: Name of the Review Stage
          - `reviewers` EntryReviewProcessStagesItemsReviewersItems[]: Reviewers for the Review Stage
            - `handle` string
            - `id` string
            - `name` string
            - `status` 'BLOCKED' | 'PENDING' | 'FINISHED' | 'REJECTED': Status of the Reviewer
        - `type` 'SELF_REVIEW' | 'SEQUENTIAL' | 'PARALLEL': Type of the Review Process
      - `status` 'ACCEPTED' | 'NEEDS_REVIEW' | 'REJECTED' | 'RETRACTED' | 'ACCEPTANCE_SNAPSHOT_IN_PROGRESS' | 'REVIEW_SNAPSHOT_IN_PROGRESS' | 'IN_PROGRESS' | 'ACTION_REQUIRED': Review Status of the worksheet
    - `webURL` string: URL of the worksheet

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)