---
title: "List boxes"
method: GET
path: "/boxes"
tags: ["boxes"]
---

# List boxes

`GET /boxes`

## Request

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

List boxes

## Query parameters

- `pageSize` integer
- `nextToken` string
- `sort` 'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc' | 'name' | 'name:asc' | 'name:desc' | 'createdAt' | 'createdAt:asc' | 'createdAt:desc' | 'barcode' | 'barcode:asc' | 'barcode:desc': Method by which to order search results. Valid sorts are barcode, name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.
- `schemaId` string
- `schemaFields` SchemaFieldsQueryParam
- `createdAt` string
- `modifiedAt` string
- `name` string
- `nameIncludes` string
- `emptyPositions` integer
- `emptyPositions.gte` integer
- `emptyPositions.gt` integer
- `emptyPositions.lte` integer
- `emptyPositions.lt` integer
- `emptyContainers` integer
- `emptyContainers.gte` integer
- `emptyContainers.gt` integer
- `emptyContainers.lte` integer
- `emptyContainers.lt` integer
- `ancestorStorageId` string
- `storageContentsId` string
- `storageContentsIds` string
- `archiveReason` string
- `ids` string
- `barcodes` string
- `names.anyOf` string
- `names.anyOf.caseSensitive` string
- `creatorIds` string

## Response `200`

OK

- BoxesPaginatedList
  - `boxes` 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
  - `nextToken` 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)