Skip to navigation
Benchling APIApp Session

Get AppSession by ID

Beta
Get a single AppSession by ID.

Authentication

AuthorizationBearer

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

Path parameters

app_session_idstringRequired
ID of the AppSession.

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
The Benchling App installation that owns this session.
createdAtstringOptional
idstringOptional
messageslist of objectsOptional
The messages currently displayed to the user, from the most recent session version.
modifiedAtstringOptional
namestringOptional
statusenumOptional
The current lifecycle status of this session, derived from the most recent version.
Allowed values:
timeoutSecondsintegerOptional
Maximum duration in seconds before the session times out automatically. Once the session's age exceeds this value and the session has not been finalized, its status becomes TIMEOUT.

Errors

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