BEbenchling
boxes

List boxes

List boxes

get/boxes

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • 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' | 'createdAt' | 'createdAt:asc' | 'createdAt:desc' | 'barcode' | 'barcode:asc' | 'barcode:desc'

Method by which to order search results. Valid sorts are barcode, name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.

schemaIdstring

ID of a schema. Restricts results to those of the specified schema.

schemaFieldsSchemaFieldsQueryParam

Filter based on schema field value (not display value). Restricts results to those with a field whose value matches the filter. For Integer, Float, and Date type fields, supports the >= and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.

createdAtstring

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those created 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.

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.

namestring

Name of a box. Restricts results to those with the specified name.

nameIncludesstring

Name substring of a box. Restricts results to those with names that include the provided substring.

emptyPositionsinteger

Only return boxes that have the specified number of empty positions

emptyPositions.gteinteger

Only return boxes that have greater-than or equal-to the specified number of empty positions.

emptyPositions.gtinteger

Only return boxes that have greater-than the specified number of empty positions.

emptyPositions.lteinteger

Only return boxes that have less-than or equal-to the specified number of empty positions.

emptyPositions.ltinteger

Only return boxes that have less-than the specified number of empty positions.

emptyContainersinteger

Only return boxes that have the specified number of empty containers (containers without contents).

emptyContainers.gteinteger

Only return boxes that have greater-than or equal-to the specified number of empty containers (containers without contents).

emptyContainers.gtinteger

Only return boxes that have greater-than the specified number of empty containers (containers without contents).

emptyContainers.lteinteger

Only return boxes that have less-than or equal-to the specified number of empty containers (containers without contents).

emptyContainers.ltinteger

Only return boxes that have less-than the specified number of empty containers (containers without contents).

ancestorStorageIdstring

ID of a location. Restricts results to those located in the specified inventory.

storageContentsIdstring

ID of a entity, or entity schema. Restricts results to those that hold containers with entities associated with the specified ID.

storageContentsIdsstring

Comma-separated list of IDs of entities. Restricts results to those that hold containers with at least one of the specified entities.

archiveReasonstring

Archive reason. Restricts items to those with the specified archive reason. Use "NOT_ARCHIVED" to filter for unarchived boxes. Use "ANY_ARCHIVED" to filter for archived boxes regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived.

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.

barcodesstring

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

names.anyOfstring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case insensitive. Warning - this filter can be non-performant due to case insensitivity.

names.anyOf.caseSensitivestring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case sensitive.

creatorIdsstring

Comma separated list of users IDs

Response

OK

nextTokenstring

Changes

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