BEbenchling
plates

Get a plate

Get a plate

get/plates/{plate_id}

Request

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

Path parameters

plate_idstring required

Query parameters

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

OK

availableCapacityinteger nullable

The number of available positions in a matrix plate. Null for well plates.

barcodestring nullable

Barcode of the plate

createdAtstring date-time

DateTime the container was created

fieldsFields
idstring

ID of the plate

modifiedAtstring date-time

DateTime the plate was last modified

namestring

Name of the plate, defaults to barcode if name is not provided.

occupiedCapacityinteger nullable

The number of containers currently in a matrix plate. Null for well plates.

parentStorageIdstring nullable

ID of containing parent inventory (e.g. loc_k2lNspzS).

projectIdstring nullable

ID of the project if set

totalCapacityinteger nullable

The total capacity of a matrix plate (i.e. how many containers it can store). Null for well plates.

type'matrix_plate' | 'well_plate'
webURLstring
wellsobject

Well contents of the plate, keyed by position string (eg. "A1").

Changes

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