Skip to navigation
Benchling APICollaboration

Get Collaboration by ID

Beta
Get a single Collaboration by ID.

Authentication

AuthorizationBearer

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

Path parameters

collaboration_idstringRequired
ID of the Collaboration.

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
accessPolicyobjectOptional
collaboratorInfoobjectOptional
Union of PrincipalCollaboratorInfo, GroupCollaboratorInfo
createdAtstringOptional
fromOwnershipbooleanOptional
idstringOptional
isAuditorbooleanOptional
modifiedAtstringOptional
resourceobjectOptional

Errors

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