projects

List project collaborations

Returns information about collaborations on the specified project.

get/projects/{projectId}/collaborations

Request

Base URL
https://{tenant_name}.benchling.com/api/v2-beta
Auth
HTTP bearer

Path parameters

projectIdstring required

ID of project for which to retrieve collaborations.

Query parameters

userIdstring

ID of user for which to retrieve collaborations.

appIdstring

ID of app for which to retrieve collaborations.

teamIdstring

ID of team for which to retrieve collaborations.

organizationIdstring

ID of organization for which to retrieve collaborations.

role'ADMIN' | 'MEMBER'

Organization or team membership role for which to retrieve collaborations.

idsstring

Comma-separated list of collaboration ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

createdAt.ltstring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.

createdAt.gtstring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.

modifiedAt.ltstring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.

modifiedAt.gtstring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.

modifiedAt.ltestring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified on or before the specified time. e.g. <= 2017-04-30.

modifiedAt.gtestring

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified on or after the specified time. e.g. >= 2017-04-30.

pageSizeinteger

Number of collaborations to return. Defaults to 50, maximum of 100.

nextTokenstring

Token for pagination

sort'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc'

Method by which to order search results. Valid sort method is modifiedAt (modified time, most recent first). Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.

Response