BEbenchling
Location

Get Location by ID

Get a single Location by ID.

get/api/v3/location/{location_id}

Request

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

Path parameters

location_idstring required

ID of the Location.

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
allowNonLocationChildrenboolean

Whether this location can store plates, boxes, and containers.

archiveReasonstring nullable
archivedboolean
availableCapacityinteger nullable

The number of available positions in this location. Null if totalCapacity is not set.

barcodestring nullable
createdAtstring datetime nullable
idstring
modifiedAtstring datetime nullable
namestring nullable
occupiedCapacityinteger nullable

The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set.

totalCapacityinteger nullable

The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.

validationStatus'PASSED' | 'FAILED'

Whether this location is passing all validation checks.

Changes

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