---
title: "List MoleculeSchema items"
method: GET
path: "/api/v3/molecule-schema/items"
tags: ["Molecule Schema"]
---

# List MoleculeSchema items

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

## Request

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

List MoleculeSchema 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

- MoleculeSchemaPaginatedList
  - `items` MoleculeSchema[]
    - `__typename` string
    - `archiveReason` string, nullable
    - `archived` boolean
    - `availableRegistrationNamingOptions` MoleculeSchemaAvailableRegistrationNamingOptionsItems[]
    - `constraint` Constraint: Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see `fieldDefinitionNames`) or unique domain-specific properties (see `TypeSpecificConstraint`). The hasUniqueResidues field is a legacy indicator for sequence uniqueness.
      - `__typename` string
      - `fieldDefinitionNames` string[], nullable
      - `hasUniqueResidues` boolean, nullable
    - `containableType` 'NONE' | 'ENTITY' | 'BATCH'
    - `containerNameTemplate` ContainerNameTemplate: A name template for containers.
      - `__typename` string
      - `parts` ContainerNameTemplatePart[]
        - `__typename` string
        - `configuration` union: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration
          - object: Configuration for a schema field name template part.
            - `__typename` string, required
            - `field` SchemaFieldDefinitionRef
              - …
          - object: Configuration for a literal text name template part.
            - `__typename` string, required
            - `text` string
        - `type` 'BARCODE' | 'BARCODE_NUMBER' | 'CHILD_ENTITY_LOT_NUMBER' | 'CONCENTRATION_UNITS' | 'CONCENTRATION_VALUE' | 'CONTAINED_ENTITY_NAME' | 'CONTAINER_CREATED_AT_DATE' | 'CONTAINER_CREATED_AT_YEAR' | 'FIELD' | 'FILL_DATE' | 'FILL_YEAR' | 'HOISTED_FIELD' | 'LINKED_BIOENTITY_REGISTRY_IDENTIFIER' | 'PARENT_STORABLE_BARCODE' | 'PARENT_STORABLE_NAME' | 'POSITION' | 'PROJECT' | 'QUANTITY_UNITS' | 'QUANTITY_VALUE' | 'REGISTRY_IDENTIFIER_NUMBER' | 'REGISTRY_IDENTIFIER_NUMBER_BASE_26' | 'RESTRICTION_STATUS' | 'SAMPLE_LOT_NUMBER' | 'SEPARATOR' | 'TEXT'
    - `createdAt` string, datetime, nullable
    - `description` string
    - `fieldDefinitions` string, uri
    - `fieldsets` string, uri
    - `iconId` 'BASIC_FOLDER_ITEM' | 'SMALL_MOLECULE' | 'SMALL_MOLECULE_BEAKER'
    - `id` string
    - `includeRegistryIdInChips` boolean
    - `itemIdPrefix` string
    - `modifiedAt` string, datetime
    - `name` string
    - `nameTemplate` EntityNameTemplate: A name template for entities.
      - `__typename` string
      - `parts` EntityNameTemplatePart[]
        - `__typename` string
        - `configuration` union: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration, ProteinChainNameTemplatePartConfiguration, ProteinDomainNameTemplatePartConfiguration
          - object: Configuration for a schema field name template part.
            - `__typename` string, required
            - `field` SchemaFieldDefinitionRef
              - …
          - object: Configuration for a protein chain name template part.
            - `__typename` string, required
            - `proteinChain` ProteinFormatChain: A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their label in the format. Chains can have multiplicity, meaning there are multiple physical instances of the same chain in a protein of this format.
              - …
          - object: Configuration for a protein domain name template part.
            - `__typename` string, required
            - `proteinDomain` ProteinFormatDomain: A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by their label in the format.
              - …
          - object: Configuration for a literal text name template part.
            - `__typename` string, required
            - `text` string
        - `type` 'CHILD_ENTITY_LOT_NUMBER' | 'COMPLEX_POLYMER_COMPONENT' | 'CREATED_AT_DATE' | 'CREATED_AT_YEAR' | 'FIELD' | 'HOISTED_FIELD' | 'LINKED_BIOENTITY_REGISTRY_IDENTIFIER' | 'PROJECT' | 'PROTEIN_CHAIN' | 'PROTEIN_DOMAIN' | 'REGISTRY_IDENTIFIER_NUMBER' | 'REGISTRY_IDENTIFIER_NUMBER_BASE_26' | 'SALT_CODES' | 'SEPARATOR' | 'TEXT'
      - `shouldOrderPartsBySequence` boolean
    - `organization` OrganizationRef
      - `__typename` string
      - `id` string, api_id
    - `systemCategories` SystemCategoryConfiguration[]
      - union
        - object: Default configuration for system categories that require no additional configuration.
          - `__typename` 'BaseSystemCategoryConfiguration', required: Discriminator value: BaseSystemCategoryConfiguration
          - `systemCategory` SystemCategoryRef
            - `__typename` string
            - `id` string, api_id
        - object: Configuration that can be set on entity schemas, which enables enabling freeze/thaw cycle tracking. When enabled, containers holding entities of the schema automatically display a "Freeze/thaw count" system field that tracks how many times the sample has been frozen and thawed. The optional limit field specifies the maximum number of freeze/thaw cycles permitted before the sample is considered unfit for use; exceeding this limit can trigger warnings in inventory workflows. Once enabled on a schema, freeze/thaw tracking cannot be disabled. This feature is commonly used for biologics, enzymes, and other temperature-sensitive samples where repeated freeze/thaw cycles can degrade sample quality.
          - `__typename` 'FreezeThawTrackingConfiguration', required: Discriminator value: FreezeThawTrackingConfiguration
          - `limit` integer, nullable: Max number of freeze/thaw cycles a container containing an entity of this schema is permitted to undergo while still being considered fit for use.
          - `systemCategory` SystemCategoryRef
            - `__typename` string
            - `id` string, api_id
    - `systemName` string
    - `useRegistryIdForItemDisplayLabel` boolean
    - `validationRules` string, uri
  - `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/c9f087b98b8b?raw)