Skip to navigation
Benchling APIWorksheet

Get Worksheet by ID

Beta
Get a single Worksheet by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

worksheet_idstringRequired
ID of the Worksheet.

Headers

EARLY-ACCESSstringOptional

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

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

OK
__typenamestringOptional
applicableReviewProcessesstringOptionalformat: "uri"
archiveReasonstring or nullOptional
archivedbooleanOptional
authorsstring or nullOptionalformat: "uri"
createdAtstringOptional
creatorobjectOptional
folderobjectOptional
idstringOptional
modifiedAtstringOptional
namestringOptional
reviewobject or nullOptional
reviewSourceobjectOptional

Errors

400
Worksheet Get Request Bad Request Error
403
Worksheet Get Request Forbidden Error
404
Worksheet Get Request Not Found Error
429
Worksheet Get Request Too Many Requests Error
500
Worksheet Get Request Internal Server Error