Skip to navigation
Benchling APIUnit

Get Unit by ID

Get a single Unit by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

unit_idstringRequired
ID of the Unit.

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

OK
__typenamestringOptional
aliaseslist of stringsOptional

Any additional short-form labels that should be recognized in input

archiveReasonstring or nullOptional
archivedbooleanOptional
conversionFactorstringOptional
Conversion factor relative to the UnitType's baseUnit. E.g. for a kilometer, the baseUnit is meter and the conversionFactor is 1000.
createdAtstring or nullOptional
idstringOptional
modifiedAtstring or nullOptional
namestringOptional

Default long-form identifier, e.g. “meter”.

symbolstringOptional

Default short-form label, e.g. “m” for meter.

unitTypeobjectOptional

The unit type this unit belongs to. Units within the same UnitType are inter-convertible.

Errors

400
Unit Get Request Bad Request Error
403
Unit Get Request Forbidden Error
404
Unit Get Request Not Found Error
429
Unit Get Request Too Many Requests Error
500
Unit Get Request Internal Server Error