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

# List plates

`GET /plates`

## Request

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

List plates

## Query parameters

- `pageSize` integer
- `nextToken` string
- `sort` 'barcode' | 'barcode:asc' | 'barcode:desc' | 'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc' | 'name' | 'name:asc' | 'name:desc' | 'createdAt' | 'createdAt:asc' | 'createdAt:desc'
- `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
- `returning` string
- `creatorIds` string

## Response `200`

OK

- PlatesPaginatedList
  - `nextToken` string
  - `plates` Plate[]
    - `archiveRecord` ArchiveRecord
      - `reason` string
    - `availableCapacity` integer, nullable: The number of available positions in a matrix plate. Null for well plates.
    - `barcode` string, nullable: Barcode of the plate
    - `createdAt` string, date-time: DateTime the container was created
    - `creator` UserSummary
      - `handle` string
      - `id` string
      - `name` string
    - `fields` Fields
    - `id` string: ID of the plate
    - `modifiedAt` string, date-time: DateTime the plate was last modified
    - `name` string: Name of the plate, defaults to barcode if name is not provided.
    - `occupiedCapacity` integer, nullable: The number of containers currently in a matrix plate. Null for well plates.
    - `parentStorageId` string, nullable: ID of containing parent inventory (e.g. loc_k2lNspzS).
    - `projectId` string, nullable: ID of the project if set
    - `schema` SchemaSummary
      - `id` string
      - `name` string
    - `totalCapacity` integer, nullable: The total capacity of a matrix plate (i.e. how many containers it can store). Null for well plates.
    - `type` 'matrix_plate' | 'well_plate'
    - `webURL` string
    - `wells` object: Well contents of the plate, keyed by position string (eg. "A1").

## 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)