---
title: "Get Fieldset by ID"
method: GET
path: "/api/v3/fieldset/{fieldset_id}"
tags: ["Fieldset"]
---

# Get Fieldset by ID

`GET /api/v3/fieldset/{fieldset_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/fieldset/{fieldset_id}`
- Auth: HTTP bearer

Get a single Fieldset by ID.

## Path parameters

- `fieldset_id` string, required

## Query parameters

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

## Response `200`

OK

- Fieldset: A tenant-defined schema interface that groups related fields to be shared across multiple schemas. Fieldsets are created and managed by tenant administrators and belong to an `Organization`. Schemas can implement an interface to inherit its `fieldDefinitions`, ensuring consistent field definitions across entity types. Unlike `SystemCategory` (which is Benchling-defined and read-only), Fieldsets can be modified by users. May include a `constraint` for uniqueness validation and a `prefix` for ID generation on implementing entities. Can be archived when no longer needed.
  - `__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
            - `__typename` string
            - `id` string, api_id
        - 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.
            - `__typename` string
            - `chainPositions` ProteinFormatChainPosition[]: A list of all the chain positions of this chain in the format.
              - …
            - `domains` ProteinFormatDomain[]: The domains that compose this chain.
              - …
            - `label` string: A human-readable label for the chain, such as 'Heavy' or 'Light 1'. Chains are labeled with an index only when multiple distinct chains of the same type exist. These labels are unique among distinct chains in a format.
            - `type` 'HEAVY' | 'LIGHT' | 'NONE' | 'ALPHA' | 'BETA' | 'JOINING': The type of the chain.
        - 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.
            - `__typename` string
            - `domainPositions` ProteinFormatDomainPosition[]: A list of all the domain positions of this domain in the format.
              - …
            - `label` string: A human-readable label for the domain, uniquely identifying the domain within the format.
            - `optional` boolean: Whether this domain is optional in the format. If true, entities of this format may not have this domain.
            - `type` 'VL' | 'CL' | 'VH' | 'VHH' | 'CH1' | 'CH2' | 'CH3' | 'CH4' | 'J' | 'H' | 'L' | 'VA' | 'CA' | 'VB' | 'CB' | 'VG' | 'CG' | 'VD' | 'CD' | 'F' | 'ELEMENT': The type of the domain (e.g., VH, VL, CH1).
        - 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)