---
title: "List Fieldset items"
method: GET
path: "/api/v3/molecule-schema/{molecule_schema_id}/fieldsets/items"
tags: ["Molecule Schema"]
---

# List Fieldset items

`GET /api/v3/molecule-schema/{molecule_schema_id}/fieldsets/items`

## Request

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

List Fieldset items.

## Path parameters

- `molecule_schema_id` string, required

## Query parameters

- `archived.anyOf` boolean[]

## Response `200`

OK

- FieldsetUnpaginatedList
  - `items` Fieldset[]
    - `__typename` string
    - `archiveReason` string, nullable: Reason the Fieldset was archived
    - `archived` boolean: If the Fieldset is archived
    - `availableRegistrationNamingOptions` FieldsetAvailableRegistrationNamingOptionsItems[]: The registration naming strategies available for entities of implementing schemas. Determines how entities are named when registered.
    - `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
    - `createdAt` string, datetime: DateTime the Fieldset was created
    - `description` string: The description of this Fieldset.
    - `displayName` string: The user-facing name of this fieldset.
    - `fieldDefinitions` string, uri: The field definitions that all schemas implementing this fieldset are required to include.
    - `id` string
    - `itemIdPrefix` string, nullable: Prefix string prepended to generated entity IDs. Setting this on a fieldset replaces the entity ID prefix on all implementing schemas.
    - `itemType` 'AA_SEQUENCE' | 'ANTIBODY' | 'CUSTOM_ENTITY' | 'DNA_OLIGO' | 'DNA_SEQUENCE' | 'ENTRY' | 'EQUIPMENT' | 'MIXTURE' | 'MOLECULE' | 'OLIGO_CONJUGATE' | 'OLIGO_DUPLEX' | 'RNA_OLIGO' | 'RNA_SEQUENCE' | 'TRIAL_SUBJECT': The entity item type that schemas implementing this Fieldset contain (e.g. DNA_SEQUENCE, AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity type.
    - `modifiedAt` string, datetime: DateTime the Fieldset was last modified
    - `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
    - `systemName` string: The machine-readable identifier for warehouse and API access.

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