---
title: "Get a box"
method: GET
path: "/boxes/{box_id}"
tags: ["boxes"]
---

# Get a box

`GET /boxes/{box_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/boxes/{box_id}`
- Auth: HTTP bearer

Get a box

## Path parameters

- `box_id` string, required

## Response `200`

OK

- Box
  - `archiveRecord` ArchiveRecord
    - `reason` string
  - `availableCapacity` integer: The number of available positions in the box.
  - `barcode` string, nullable
  - `createdAt` string, date-time
  - `creator` UserSummary
    - `handle` string
    - `id` string
    - `name` string
  - `emptyContainers` integer: The number of containers in the box that have no contents.
  - `emptyPositions` integer: The number of empty positions for adding additional containers in the box.
  - `fields` Fields
  - `filledPositions` integer: The number of containers currently in the box.
  - `id` string
  - `modifiedAt` string, date-time
  - `name` string
  - `occupiedCapacity` integer: The number of containers currently in the box.
  - `parentStorageId` string, nullable
  - `projectId` string, nullable
  - `schema` SchemaSummary
    - `id` string
    - `name` string
  - `size` integer: The size of the box (i.e. how many containers it can store).
  - `totalCapacity` integer: The total capacity of the box (i.e. how many containers it can store).
  - `webURL` string

## Other responses

- `400`: Bad Request

---

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