How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Location API

A Location represents a physical storage area in Benchling's inventory system, such asa freezer, refrigerator, shelf, room, or building. Locations form a hierarchy whereeach location can contain child locations (e.g., a freezer contains shelves) as wellas inventory items like Boxes, Plates, and Containers when allowNonLocationChildren istrue. Each location tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity)and can restrict what types of items it accepts via allowedInventorySchemas. Locationsconform to a LocationSchema that defines custom fields for the location type. Locationsare identified by barcode for physical tracking and can be archived when no longer in use.

Benchling Location API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Location. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

This API exposes 8 operations across 7 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v3.

8 operations 7 paths 29 schemas 2 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Location API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicApiKeyAuth). It accepts HTTP basic authentication (basicClientIdSecretAuth). It supports OAuth 2.0 (oAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • basicApiKeyAuth — Use issued API key for standard access to the API
  • basicClientIdSecretAuth — Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
  • oAuth — OAuth2 Client Credentials flow intended for service access

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 2 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Location 8

A Location represents a physical storage area in Benchling's inventory system, such as a freezer, refrigerator, shelf, room, or building. Locations form a hierarchy where each loc…

POST
/location
Create Location
Location.Create body → 201400403404429500
GET
/location/items
List Location items
Location.List 24 params → 200400403404429500
GET
/location/{location_id}
Get Location by ID
Location.Get 3 params → 200400403404429500
PATCH
/location/{location_id}
Update Location
Location.Update 1 param body → 200400403404429500
POST
/location:batch-create
Batch create Location
Location.BatchCreate body → 201400403404429500
PATCH
/location:batch-update
Batch update Location
Location.BatchUpdate body → 200400403404429500
POST
/location:bulk-create
Bulk create Location
Location.BulkCreate body → 202400403404429500
PATCH
/location:bulk-update
Bulk update Location
Location.BulkUpdate body → 202400403404429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are ILocation (16 properties), UpdateLocationInputWithPathParams (7 properties), InternalServerError (6 properties), UpdateLocationInput (6 properties). Each schema is shown below with its type and property counts.

LocationPaginatedList
object
2 properties
FieldValueInput
object
1 property 1 required
AnyType
DateValue
object
A type that represents date values.
2 properties
BooleanValue
object
A type that represents boolean values.
2 properties
UpdateLocationInputWithPathParams
object
7 properties 1 required
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
Location
ILocation
object
16 properties
LocationSchemaRef
object
2 properties
InternalServerError
object
6 properties 5 required
SchemaFieldValue
object
Represents a field value on a schematized object, pairing a fieldDefinition (describing the field's type and constraints) with its actual value (a BenchlingVal…
5 properties
DecimalValue
object
A type that represents decimal value as strings.
3 properties
AsyncTaskLink
object
2 properties
CreateLocationInput
object
5 properties 2 required
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
UpdateLocationInput
object
6 properties
LocationRef
object
2 properties
BulkImport
object
1 property 1 required
PrincipalRef
object
2 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
ObjectRef
object
2 properties
TextValue
object
A type that represents text (string) values.
2 properties
JsonValue
object
A type that represents JSON values.
2 properties
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 properties
IntegerValue
object
A type that represents integer values.
2 properties
SchemaFieldDefinitionRef
object
2 properties
GeneralError
object
5 properties 5 required
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-location-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Where this information came from

This is an independent, third-party profile of Benchling Location API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.