Benchling

Benchling Dropdown API

A configurable list of predefined values used for standardizing data entry in schema fields. Dropdowns provide controlled vocabulary choices that ensure consistency when users fill out entity and object fields. Each Dropdown belongs to a Registry (see `registry`) and contains one or more selectable options (see `DropdownOption`). Dropdowns are referenced by schema field definitions (see `DropdownLinkFieldDefinition`) to constrain the allowed values for a field. Organizations use dropdowns to enforce standardized terminology across experiments, samples, and other registered entities.

GitHub OpenAPI

Operations 9

POST /dropdown Create Dropdown #
GET /dropdown/items List Dropdown items #
GET /dropdown/{dropdown_id} Get Dropdown by ID #
PATCH /dropdown/{dropdown_id} Update Dropdown #
GET /dropdown/{dropdown_id}/options/items List DropdownOption items #
POST /dropdown:batch-create Batch create Dropdown #
PATCH /dropdown:batch-update Batch update Dropdown #
POST /dropdown:bulk-create Bulk create Dropdown #
PATCH /dropdown:bulk-update Bulk update Dropdown #

Documentation

📖
Documentation
https://docs.benchling.com/docs/developer-platform-overview
📖
APIReference
https://benchling.com/api/v3/reference
📖
Authentication
https://artifacts.apis.io/benchling/authentication/benchling-authentication.yml
📖
RateLimits
https://artifacts.apis.io/benchling/rate-limits/benchling-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/benchling/openapi/benchling-dropdown-api-openapi.yml

Other Resources

🔗
OpenAPIRemote
https://benchling.com/api/v3/openapi.yaml
🔗
Conventions
https://artifacts.apis.io/benchling/conventions/benchling-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/benchling/errors/benchling-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/benchling/data-model/benchling-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/benchling/asyncapi/benchling-webhooks.yml
🔗
Lifecycle
https://artifacts.apis.io/benchling/lifecycle/benchling-lifecycle.yml
🔗
ChangeLog
https://artifacts.apis.io/benchling/changelog/benchling-changelog.yml
🔗
StabilityPolicy
https://docs.benchling.com/docs/stability-guidelines
🔗
SDKs
https://artifacts.apis.io/benchling/packages/benchling-packages.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/benchling:benchling-dropdown-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

benchling-dropdown-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Benchling Dropdown API
  version: 2.0.0
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged Dropdown across 2 of this provider''s published API definitions: benchling-openapi.yml, benchling-v3-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'A configurable list of predefined values used for standardizing data entry in schema fields.

    Dropdowns provide controlled vocabulary choices that ensure consistency when users fill out

    entity and object fields. Each Dropdown belongs to a Registry (see `registry`) and contains

    one or more selectable options (see `DropdownOption`). Dropdowns are referenced by schema

    field definitions (see `DropdownLinkFieldDefinition`) to constrain the allowed values for a

    field. Organizations use dropdowns to enforce standardized terminology across experiments,

    samples, and other registered entities.'
  name: Dropdown
  x-bnch-organization: Benchling
  x-displayName: Dropdown
paths:
  /dropdown:
    post:
      description: Create Dropdown.
      operationId: Dropdown.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDropdownInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Create Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown/items:
    get:
      description: List Dropdown items.
      operationId: Dropdown.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownPaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List Dropdown items
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown/{dropdown_id}:
    get:
      description: Get a single Dropdown by ID.
      operationId: Dropdown.Get
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Dropdown by ID
      tags:
      - Dropdown
    patch:
      description: Update Dropdown.
      operationId: Dropdown.Update
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDropdownInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown/{dropdown_id}/options/items:
    get:
      description: List DropdownOption items.
      operationId: Dropdown.options.List
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/archived.anyOf'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownOptionUnpaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List DropdownOption items
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown:batch-create:
    post:
      description: Batch create Dropdown synchronously in one transaction. Maximum 25 items per request.
      operationId: Dropdown.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDropdownInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Dropdown'
                    type: array
                required:
                - items
                type: object
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Batch create Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown:batch-update:
    patch:
      description: Batch update Dropdown synchronously in one transaction. Maximum 25 items per request.
      operationId: Dropdown.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDropdownInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Dropdown'
                    type: array
                required:
                - items
                type: object
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Batch update Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown:bulk-create:
    post:
      description: Bulk create Dropdown.
      operationId: Dropdown.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Bulk create Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
  /dropdown:bulk-update:
    patch:
      description: Bulk update Dropdown.
      operationId: Dropdown.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Bulk update Dropdown
      tags:
      - Dropdown
    servers:
    - url: /api/v3
components:
  schemas:
    CreateDropdownOptionInput:
      additionalProperties: false
      properties:
        name:
          description: The display name of this dropdown option.
          type: string
      required:
      - name
      type: object
    DropdownPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Dropdown'
          type: array
        nextToken:
          type:
          - string
          - 'null'
      type: object
    Dropdown:
      description: 'A configurable list of predefined values used for standardizing data entry in schema fields.

        Dropdowns provide controlled vocabulary choices that ensure consistency when users fill out

        entity and object fields. Each Dropdown belongs to a Registry (see `registry`) and contains

        one or more selectable options (see `DropdownOption`). Dropdowns are referenced by schema

        field definitions (see `DropdownLinkFieldDefinition`) to constrain the allowed values for a

        field. Organizations use dropdowns to enforce standardized terminology across experiments,

        samples, and other registered entities.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        id:
          description: ID of the dropdown
          type: string
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          format: uri
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The registry that the dropdown belongs to
      type: object
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    CreateDropdownInput:
      additionalProperties: false
      properties:
        name:
          description: Name of the dropdown. Must be unique within the registry.
          type: string
        options:
          description: The initial list of selectable options.
          items:
            $ref: '#/components/schemas/CreateDropdownOptionInput'
          type: array
        registryId:
          description: The API ID of the registry this dropdown belongs to.
          type: string
      required:
      - name
      - registryId
      - options
      type: object
    UpdateDropdownOptionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: Updated display name.
          type: string
      required:
      - id
      type: object
    TooManyRequestsError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    RegistryRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    UpdateDropdownInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: Updated dropdown name.
          type: string
        options:
          description: Replacement list of options. Include existing options to retain them.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput'
          type: array
      required:
      - id
      type: object
    DropdownOptionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DropdownOption'
          type: array
      type: object
    AsyncTaskLink:
      properties:
        pollingUri:
          format: uri
          type: string
        taskId:
          type: string
      type: object
    InternalServerError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        errorId:
          type: string
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    BulkImport:
      example:
        fileId: scrfile_jdf8BV24kLmN
      properties:
        fileId:
          description: The API ID of the scratch file (`scrfile_XXXXXXXX`) containing the items to import. The referenced file must be a scratch file whose upload has completed successfully.
          type: string
      required:
      - fileId
      type: object
    DropdownOption:
      description: 'An individual selectable value within a Dropdown. Each DropdownOption represents one valid

        choice that users can select when populating a schema field configured with the parent

        Dropdown. Options can be archived to remove them from the available choices while preserving

        historical data that references them. The option''s name is displayed to users when selecting

        values.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      type: object
    UpdateDropdownInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          description: Updated dropdown name.
          type: string
        options:
          description: Replacement list of options. Include existing options to retain them.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput'
          type: array
      type: object
    CreateDropdownOptionInput_2:
      additionalProperties: false
      properties:
        name:
          type: string
      required:
      - name
      type: object
    DropdownPaginatedList_2:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Dropdown'
          type: array
        nextToken:
          type: string
      type: object
    GeneralError_2:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    CreateDropdownInput_2:
      additionalProperties: false
      properties:
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            $ref: '#/components/schemas/CreateDropdownOptionInput_2'
          type: array
        registryId:
          type: string
      required:
      - name
      - registryId
      - options
      type: object
    UpdateDropdownOptionInput_2:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateDropdownInputWithPathParams_2:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput_2'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput_2'
          type: array
      required:
      - id
      type: object
    UpdateDropdownInput_2:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput_2'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput_2'
          type: array
      type: object
  responses:
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    Conflict:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Conflict
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/TooManyRequestsError'
      description: Too Many Requests
      headers:
        Retry-After:
          description: Minimum number of seconds to wait before retrying. Only included when the request exceeded a rate limit specific to the caller. Limits shared with other callers, such as tenant-wide limits, omit this header because the wait depends on their traffic.
          required: false
          schema:
            minimum: 1
            type: integer
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
    TooManyRequests_2:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError_2'
      description: Too Many Requests
  parameters:
    omit:
      description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
      explode: false
      in: query
      name: omit
      schema:
        items:
          type: string
        type: array
    name.anyOf:
      description: Restricts results to those that match any of the specified names. Case insensitive. Warning - this filter can be non-performant due to case insensitivity. Ensure only one name filter is used at a time. Comma-separated list.
      explode: false
      in: query
      name: name.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    name.anyOf.caseSensitive:
      description: Restricts results to those that match any of the specified names. Case sensitive. Ensure only one name filter is used at a time. Comma-separated list.
      explode: false
      in: query
      name: name.anyOf.caseSensitive
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    archived.anyOf:
      description: If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list.
      explode: false
      in: query
      name: archived.anyOf
      schema:
        items:
          type: boolean
        maxItems: 2
        type: array
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    returning:
      description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
      explode: false
      in: query
      name: returning
      schema:
        items:
          type: string
        type: array
    archiveReason.anyOf:
      description: Restricts items to those with any of the specified archive reasons. Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived. Comma-separated list.
      explode: false
      in: query
      name: archiveReason.anyOf
      schema:
        items:
          type: string
        maxItems: 10
        type: array
    id.anyOf:
      description: Restricts results to those matching any of the specified IDs. Comma-separated list.
      explode: false
      in: query
      name: id.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
  securitySchemes:
    BearerAuth:
      description: Use a short-lived V3 API Explorer token.
      scheme: bearer
      type: http
      x-fern-playground-description: Copy a short-lived V3 API Explorer token from the user's settings page
    basicApiKeyAuth:
      description: Use issued API key for standard access to the API
      scheme: basic
      type: http
    basicClientIdSecretAuth:
      description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
      scheme: basic
      type: http
    oAuth:
      description: OAuth2 Client Credentials flow intended for service access
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth/token
      type: oauth2
x-refined-from:
- benchling-openapi.yml
- benchling-v3-openapi.yaml