Skip to navigation
Benchling APIApp Canvas

Get AppCanvas by ID

Beta
Get a single AppCanvas by ID.

Authentication

AuthorizationBearer

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

Path parameters

app_canvas_idstringRequired
ID of the AppCanvas.

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
appobjectOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
blockslist of objectsOptional
createdAtstringOptional
datastring or nullOptional
enabledbooleanOptional
featureIdstring or nullOptional
idstringOptional
modifiedAtstringOptional
resourceIdstringOptional
sessionIdstring or nullOptional

Errors

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