---
title: "Get BoxSchema by ID"
method: GET
path: "/api/v3/box-schema/{box_schema_id}"
tags: ["Box Schema"]
---

# Get BoxSchema by ID

`GET /api/v3/box-schema/{box_schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/box-schema/{box_schema_id}`
- Auth: HTTP bearer

Get a single BoxSchema by ID.

## Path parameters

- `box_schema_id` string, required

## Query parameters

- `returning` string[]
- `omit` string[]

## Response `200`

OK

- BoxSchema: 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".
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `containerSchema` ContainerSchemaRef
    - `__typename` string
    - `id` string, api_id
  - `createdAt` string, datetime, nullable
  - `description` string: A description of the schema.
  - `fieldDefinitions` string, uri
  - `height` integer, nullable
  - `id` string
  - `modifiedAt` string, datetime, nullable
  - `name` string
  - `prefix` string, nullable
  - `registry` RegistryRef
    - `__typename` string
    - `id` string, api_id
  - `systemName` string: A unique, stable identifier for this schema used for programmatic access and integrations.
  - `type` string, nullable
  - `width` integer, nullable

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)