---
title: "Get StudySchema by ID"
method: GET
path: "/api/v3/study-schema/{study_schema_id}"
tags: ["Study Schema"]
---

# Get StudySchema by ID

`GET /api/v3/study-schema/{study_schema_id}`

## Request

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

Get a single StudySchema by ID.

## Path parameters

- `study_schema_id` string, required

## Query parameters

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

## Response `200`

OK

- StudySchema: A configuration template that defines the structure and behavior of Studies within an organization. Each `StudySchema` specifies the `studyType`, which determines available features and workflow capabilities. Schemas define custom fields through `fieldDefinitions` that studies of this type must populate. The `isDesignApprovalRequired` flag controls whether study designs must go through a review process before execution. Associated `entryTemplates` provide standardized notebook templates for documenting study work. Studies reference their schema via `Study.studySchema`.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime, nullable
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `description` string: A description of this study schema for documentation purposes.
  - `entryTemplates` string, uri
  - `fieldDefinitions` string, uri
  - `id` string
  - `idGenerationMode` 'AUTO_GENERATED_FROM_PREFIX' | 'MANUAL': How Study IDs are assigned for studies of this schema.
  - `isDesignApprovalRequired` boolean
  - `modifiedAt` string, datetime, nullable
  - `name` string
  - `organization` OrganizationRef
    - `__typename` string
    - `id` string, api_id
  - `prefix` string, nullable
  - `studyType` 'CUSTOM' | 'PROCESS_DEVELOPMENT' | 'ASSAY_DEVELOPMENT' | 'CLINICAL' | 'PRECLINICAL'

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