Box

Get Box by ID

Get a single Box by ID.

get/api/v3/box/{box_id}

Request

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

Path parameters

box_idstring required

ID of the Box.

Query parameters

returningstring[]

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

omitstring[]

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

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
availableCapacityinteger

The number of available positions in the box.

barcodestring nullable
createdAtstring datetime nullable
emptyContainersinteger nullable

The number of containers in the box that have no contents.

idstring
modifiedAtstring datetime nullable
namestring nullable
occupiedCapacityinteger

The number of containers currently in the box.

totalCapacityinteger

The total capacity of the box (i.e. how many containers it can store).

Changes

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