# Benchling Box Schema API

**Canonical:** https://apis.io/apis/benchling/benchling-boxschema-api/  
**Provider:** Benchling — https://apis.io/providers/benchling/  
**Base URL:** https://{tenant}.benchling.com/api/v2  
**Documentation:** https://docs.benchling.com/docs/developer-platform-overview

Benchling Box Schema API is one of 203 APIs that [Benchling](https://apis.io/providers/benchling/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include BoxSchema. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

Defines the structure and constraints for a category of Boxes in Benchling's inventory system. A BoxSchema specifies the grid dimensions (height and width) determining how many container positions the box has, and optionally links to a ContainerSchema that constrains what type of containers can be stored in boxes of this type. BoxSchemas support custom field definitions for capturing additional metadata about boxes. Each BoxSchema can be associated with a Registry and given a prefix for generating display IDs. Examples include "96-Well Freezer Box" or "81-Position Cryo Box".

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| POST | `/box-schema` | Create BoxSchema |
| GET | `/box-schema/items` | List BoxSchema items |
| GET | `/box-schema/{box_schema_id}` | Get BoxSchema by ID |
| PATCH | `/box-schema/{box_schema_id}` | Update BoxSchema |
| GET | `/box-schema/{box_schema_id}/field-definitions/items` | List SchemaFieldDefinition items |
| POST | `/box-schema:batch-create` | Batch create BoxSchema |
| PATCH | `/box-schema:batch-update` | Batch update BoxSchema |
| POST | `/box-schema:bulk-create` | Bulk create BoxSchema |
| PATCH | `/box-schema:bulk-update` | Bulk update BoxSchema |

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/openapi/benchling-boxschema-api-openapi.yml
- **OpenAPIRemote** — https://benchling.com/api/v3/openapi.yaml
- **Documentation** — https://docs.benchling.com/docs/developer-platform-overview
- **APIReference** — https://benchling.com/api/v3/reference
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/authentication/benchling-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/scopes/benchling-scopes.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/conventions/benchling-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/errors/benchling-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/data-model/benchling-data-model.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/asyncapi/benchling-webhooks.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/rate-limits/benchling-rate-limits.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/lifecycle/benchling-lifecycle.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/changelog/benchling-changelog.yml
- **StabilityPolicy** — https://docs.benchling.com/docs/stability-guidelines
- **SDKs** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/packages/benchling-packages.yml

## Other Benchling APIs (12)

- [Benchling AA Sequences API](https://apis.io/apis/benchling/benchling-aa-sequences-api/)
- [Benchling Apps API](https://apis.io/apis/benchling/benchling-apps-api/)
- [Benchling Assay Results API](https://apis.io/apis/benchling/benchling-assay-results-api/)
- [Benchling Assay Runs API](https://apis.io/apis/benchling/benchling-assay-runs-api/)
- [Benchling Audit API](https://apis.io/apis/benchling/benchling-audit-api/)
- [Benchling Authentication API](https://apis.io/apis/benchling/benchling-authentication-api/)
- [Benchling Blobs API](https://apis.io/apis/benchling/benchling-blobs-api/)
- [Benchling Boxes API](https://apis.io/apis/benchling/benchling-boxes-api/)
- [Benchling Codon Usage Tables API](https://apis.io/apis/benchling/benchling-codon-usage-tables-api/)
- [Benchling Connect API](https://apis.io/apis/benchling/benchling-connect-api/)
- [Benchling Containers API](https://apis.io/apis/benchling/benchling-containers-api/)
- [Benchling Custom Entities API](https://apis.io/apis/benchling/benchling-custom-entities-api/)

## Tags

BoxSchema

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/benchling/benchling-boxschema-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/benchling/.
