---
title: "Get ContainerSchema by ID"
method: GET
path: "/api/v3/container-schema/{container_schema_id}"
tags: ["Container Schema"]
---

# Get ContainerSchema by ID

`GET /api/v3/container-schema/{container_schema_id}`

## Request

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

Get a single ContainerSchema by ID.

## Path parameters

- `container_schema_id` string, required

## Query parameters

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

## Response `200`

OK

- ContainerSchema: Defines the structure and metadata for a category of Containers in Benchling's inventory system. A `ContainerSchema` specifies the container type (e.g., "1.5mL Microcentrifuge Tube", "2mL Cryovial"), custom field definitions for capturing container-specific data, and an optional Registry association with display ID prefix. `ContainerSchema`s are referenced by box and matrix plate schemas to constrain what container types can be stored in boxes or plates of that type, and by fixed plate schemas to identify the container schema for the wells, which are modeled as containers. Examples of container schemas include "Eppendorf Tube", "Falcon Tube", or custom organization-specific container types.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime, nullable
  - `description` string: A description of the schema.
  - `fieldDefinitions` string, uri
  - `id` string
  - `modifiedAt` string, datetime, nullable: DateTime the Container Schema was last modified
  - `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

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