BEbenchling
Review

Get Review by ID

Get a single Review by ID.

get/api/v3/review/{review_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

review_idstring required

ID of the Review.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

__typenamestring
createdAtstring datetime

Timestamp when this review was created

idstring

ID of the review

reviewHistorystring uri

Ordered list of ReviewChange records representing the full audit history of this review. Each ReviewChange captures a single action taken (e.g. send-for-review, approve, reject, retract), the timestamp it occurred, any associated comment, and an optional point-in-time snapshot. To query review history by the reviewable item's ID (e.g. an entry ID like etr_...) instead of the review ID, use GET /benchling/review-change/items?reviewableId.anyOf=<id>.

reviewableIdstring

API identifier of the reviewable item (e.g. an Entry) that this review belongs to.

status'REVIEW_SNAPSHOT_IN_PROGRESS' | 'NEEDS_REVIEW' | 'REJECTED' | 'RETRACTED' | 'ACCEPTANCE_SNAPSHOT_IN_PROGRESS' | 'ACCEPTED' | 'CYCLE_COMPLETED' | 'ACTION_REQUIRED'

The status of this review

Changes

No recorded changes to this operation across all 1 revision of this API.