---
title: "List StudySchema items"
method: GET
path: "/api/v3/study-schema/items"
tags: ["Study Schema"]
---

# List StudySchema items

`GET /api/v3/study-schema/items`

## Request

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

List StudySchema items.

## Query parameters

- `archiveReason.anyOf` string[]
- `archived.anyOf` boolean[]
- `createdAt.gt` string, datetime
- `createdAt.gte` string, datetime
- `createdAt.lt` string, datetime
- `createdAt.lte` string, datetime
- `id.anyOf` string[]
- `modifiedAt.gt` string, datetime
- `modifiedAt.gte` string, datetime
- `modifiedAt.lt` string, datetime
- `modifiedAt.lte` string, datetime
- `name.anyOf` string[]
- `name.anyOf.caseSensitive` string[]
- `nextToken` string
- `omit` string[]
- `pageSize` integer
- `returning` string[]
- `sort` 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt:asc' | 'modifiedAt:desc'

## Response `200`

OK

- StudySchemaPaginatedList
  - `items` 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'
  - `nextToken` 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/3873a10bf7b8?raw)
