---
title: "Get RunSchema by ID"
method: GET
path: "/api/v3/run-schema/{run_schema_id}"
tags: ["Run Schema"]
---

# Get RunSchema by ID

`GET /api/v3/run-schema/{run_schema_id}`

## Request

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

Get a single RunSchema by ID.

## Path parameters

- `run_schema_id` string, required

## Query parameters

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

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- RunSchema: Defines the structure and automation configuration for a category of Runs in Benchling's lab automation system. A RunSchema specifies field definitions for run metadata, input generator configurations (see AutomationInputFileConfig) for creating instrument worklists, and output processor configurations (see AutomationOutputFileConfig) for parsing instrument results. Schemas can be linked to an AutomationTemplate for automated data processing after runs complete. Settings control whether runs can be created from notebooks (allowCreateRunFromNotebook), inserted from the run inbox (allowInsertRunFromInbox), and whether equipment tracking is enabled (shouldRecordEquipment). Each schema is owned by an Organization and has a systemName used for Data Platform integration. RunSchemas define the automation workflow for specific assay types like qPCR, ELISA, or sequencing.
  - `__typename` string
  - `allowCreateRunFromNotebook` boolean, nullable: Whether new runs belonging to this schema can be created from the notebook
  - `allowInsertRunFromInbox` boolean, nullable: Whether runs belonging to this schema can be inserted in the notebook from the Run Inbox
  - `archiveReason` string, nullable: If the Run is archived, reason for archiving
  - `archived` boolean: Whether the Run is archived
  - `automationInputFileConfigs` string, uri: Configurations for automation input generators on this run
  - `automationOutputFileConfigs` string, uri: Configurations for automation output processors on this run
  - `createdAt` string, datetime, nullable
  - `fieldDefinitions` string, uri: Defines the metadata fields for runs belonging to this schema
  - `id` string
  - `modifiedAt` string, datetime, nullable: DateTime the Run Schema was last modified
  - `name` string: Name of the Run Schema
  - `organization` OrganizationRef
    - `__typename` string
    - `id` string, api_id
  - `shouldRecordEquipment` boolean: Whether runs belonging to this schema should record equipment or not
  - `systemName` string, nullable: Name for this schema in the Data Platform. For example, the name of the warehouse table is derived from the systemName.

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