---
title: "Get an entity schema by ID"
method: GET
path: "/entity-schemas/{schema_id}"
tags: ["schemas"]
---

# Get an entity schema by ID

`GET /entity-schemas/{schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/entity-schemas/{schema_id}`
- Auth: HTTP bearer

Get an entity schema by ID

## Path parameters

- `schema_id` string, required

## Response `200`

OK

- EntitySchema
  - `archiveRecord` ArchiveRecord
    - `reason` string
  - `fieldDefinitions` EntitySchemaFieldDefinitionsItems[]
    - union
      - SimpleFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` 'dna_sequence_link' | 'aa_sequence_link' | 'custom_entity_link' | 'entity_link' | 'mixture_link' | 'molecule_link' | 'dropdown' | 'part_link' | 'translation_link' | 'aa_part_link' | 'base_molecule_link' | 'blob_link' | 'text' | 'long_text' | 'batch_link' | 'storage_link' | 'entry_link' | 'assay_request_link' | 'assay_result_link' | 'assay_run_link' | 'boolean' | 'float' | 'integer' | 'datetime' | 'date' | 'json'
      - IntegerFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` 'dna_sequence_link' | 'aa_sequence_link' | 'custom_entity_link' | 'entity_link' | 'mixture_link' | 'molecule_link' | 'dropdown' | 'part_link' | 'translation_link' | 'aa_part_link' | 'base_molecule_link' | 'blob_link' | 'text' | 'long_text' | 'batch_link' | 'storage_link' | 'entry_link' | 'assay_request_link' | 'assay_result_link' | 'assay_run_link' | 'boolean' | 'float' | 'integer' | 'datetime' | 'date' | 'json'
        - `numericMax` number, double, nullable
        - `numericMin` number, double, nullable
        - `unit` UnitSummary
          - `id` string
          - `name` string
          - `symbol` string
          - `unitTypeId` string
      - FloatFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` 'dna_sequence_link' | 'aa_sequence_link' | 'custom_entity_link' | 'entity_link' | 'mixture_link' | 'molecule_link' | 'dropdown' | 'part_link' | 'translation_link' | 'aa_part_link' | 'base_molecule_link' | 'blob_link' | 'text' | 'long_text' | 'batch_link' | 'storage_link' | 'entry_link' | 'assay_request_link' | 'assay_result_link' | 'assay_run_link' | 'boolean' | 'float' | 'integer' | 'datetime' | 'date' | 'json'
        - `decimalPrecision` number, double, nullable
        - `legalTextDropdownId` string, nullable
        - `numericMax` number, double, nullable
        - `numericMin` number, double, nullable
        - `unit` UnitSummary
          - `id` string
          - `name` string
          - `symbol` string
          - `unitTypeId` string
      - DropdownFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` 'dna_sequence_link' | 'aa_sequence_link' | 'custom_entity_link' | 'entity_link' | 'mixture_link' | 'molecule_link' | 'dropdown' | 'part_link' | 'translation_link' | 'aa_part_link' | 'base_molecule_link' | 'blob_link' | 'text' | 'long_text' | 'batch_link' | 'storage_link' | 'entry_link' | 'assay_request_link' | 'assay_result_link' | 'assay_run_link' | 'boolean' | 'float' | 'integer' | 'datetime' | 'date' | 'json'
        - `dropdownId` string, nullable
      - SchemaLinkFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` 'dna_sequence_link' | 'aa_sequence_link' | 'custom_entity_link' | 'entity_link' | 'mixture_link' | 'molecule_link' | 'dropdown' | 'part_link' | 'translation_link' | 'aa_part_link' | 'base_molecule_link' | 'blob_link' | 'text' | 'long_text' | 'batch_link' | 'storage_link' | 'entry_link' | 'assay_request_link' | 'assay_result_link' | 'assay_run_link' | 'boolean' | 'float' | 'integer' | 'datetime' | 'date' | 'json'
        - `schemaId` string, nullable
  - `id` string
  - `name` string
  - `type` 'custom_entity' | 'dna_sequence' | 'rna_sequence' | 'aa_sequence' | 'mixture' | 'dna_oligo' | 'rna_oligo' | 'molecule'
  - `prefix` string
  - `registryId` string
  - `constraint` EntitySchemaConstraint
    - `fieldDefinitionNames` string[]
    - `hasUniqueResidues` boolean
  - `containableType` 'NONE' | 'ENTITY' | 'BATCH'
  - `containerNameTemplateParts` NameTemplatePart[], nullable
    - `datetimeFormat` string, nullable
    - `fieldId` string, nullable
    - `text` string, nullable
    - `type` string
  - `modifiedAt` string, date-time: DateTime the Entity Schema was last modified
  - `nameTemplateParts` NameTemplatePart[], nullable
    - `datetimeFormat` string, nullable
    - `fieldId` string, nullable
    - `text` string, nullable
    - `type` string

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)