BEbenchling
worklists

List worklists

List worklists. Individual items within a worklist are summarized.

get/worklists

Request

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

Query parameters

pageSizeinteger

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

nextTokenstring

Token for pagination

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

Method by which to order search results. Valid sorts are modifiedAt (modified time, most recent first) and name (entity name, alphabetical). Optionally add :asc or :desc to specify ascending or descending order.

modifiedAtstring

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

idsstring

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

worklistType'batch' | 'bioentity' | 'container' | 'plate'

The type of items a worklist contains.

The type of Worklist. All items within the worklist belong to this type.

returningstring

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, click here.

Response

Returns a list of worklists. Items within the worklist are returned as summaries only.

nextTokenstring

Changes

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