---
title: "Get WellPlateSchema by ID"
method: GET
path: "/api/v3/well-plate-schema/{well_plate_schema_id}"
tags: ["Well Plate Schema"]
---

# Get WellPlateSchema by ID

`GET /api/v3/well-plate-schema/{well_plate_schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/well-plate-schema/{well_plate_schema_id}`
- Auth: HTTP bearer

Get a single WellPlateSchema by ID.

## Path parameters

- `well_plate_schema_id` string, required

## Query parameters

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

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- WellPlateSchema: Defines the structure and constraints for a category of WellPlates in Benchling's inventory system. A WellPlateSchema specifies the grid dimensions (height and width) determining how many wells the plate has, and requires a ContainerSchema that defines the well properties (volume capacity, custom fields, etc.). Custom field definitions allow capturing plate-level metadata beyond individual well data. Each WellPlateSchema is associated with a Registry and has a prefix for generating display IDs and barcodes. Examples include "96-Well PCR Plate", "384-Well Assay Plate", or organization-specific plate formats. Unlike MatrixPlateSchema which defines tube rack formats with removable containers, WellPlateSchema is for fixed-well plates where wells are permanent.
  - `__typename` string
  - `archiveReason` string, nullable: Why the schema was archived.
  - `archived` boolean: Whether the schema is archived.
  - `containerSchema` ContainerSchemaRef
    - `__typename` string
    - `id` string, api_id
  - `createdAt` string, datetime: When the schema was created.
  - `description` string: A description of the schema.
  - `fieldDefinitions` string, uri: The fields inherited by plates of this schema.
  - `height` integer: The number of rows in plates of this schema.
  - `id` string: The ID of the schema.
  - `modifiedAt` string, datetime: When the schema was last modified.
  - `name` string: The name of the schema.
  - `prefix` string: The prefix of barcodes autogenerated for plates of this schema.
  - `registry` RegistryRef
    - `__typename` string
    - `id` string, api_id
  - `systemName` string: A unique, stable identifier for this schema used for programmatic access and integrations.
  - `width` integer: The number of columns in plates of this schema.

## 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/3873a10bf7b8?raw)