BEbenchling
Collaboration

List Collaboration items

List Collaboration items.

get/api/v3/collaboration/items

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Query parameters

collaboratorId.anyOfstring[]

Restricts results to collaborations for any of the specified collaborator IDs. Comma-separated list.

createdAt.gtstring datetime

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

createdAt.gtestring datetime

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

createdAt.ltstring datetime

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.ltestring datetime

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

id.anyOfstring[]

Restricts results to those matching any of the specified IDs. Comma-separated list.

modifiedAt.gtstring datetime

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.gtestring datetime

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

modifiedAt.ltstring datetime

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.ltestring datetime

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

nextTokenstring

Token for pagination

omitstring[]

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

pageSizeinteger

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

resourceId.anyOfstring[]

Restricts results to collaborations on any of the specified resource IDs. Comma-separated list.

resourceId.includeInheritedboolean

When true, also matches collaborations inherited from the ancestors of the resources given by resourceId.anyOf, in addition to those directly on them. Has no effect unless resourceId.anyOf is provided.

returningstring[]

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

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

Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.

Response

OK

nextTokenstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.