Benchling

Benchling Test Order API

A Test Order represents an individual request to perform a specific test on a sample. Each Test Order references a `TestDefinition` that specifies what type of test to perform, and a `sample` (Entity) that is being tested. Test Orders track their lifecycle through `status` (see `TestStatus`), from PENDING when created, through IN_PROGRESS during execution, to COMPLETED or other terminal states. When executed via an Assay workflow, the `procedure` and `procedureMethodExecutionInstance` fields link to the execution context. Results are captured in the `result` field. Test Orders can be associated with `Study` objects for clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations` for laboratory execution tracking.

Documentation GitHub OpenAPI

Operations 2

GET /test-order/items List TestOrder items #

GET /test-order/{test_order_id} Get TestOrder by ID #

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-testorder-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Test Order API
  version: 2.0.0
  description: 'A Test Order represents an individual request to perform a specific test on a sample. Each

    Test Order references a `TestDefinition` that specifies what type of test to perform, and

    a `sample` (Entity) that is being tested. Test Orders track their lifecycle through `status`

    (see `TestStatus`), from PENDING when created, through IN_PROGRESS during execution, to

    COMPLETED or other terminal states. When executed via an Assay workflow, the `procedure`

    and `procedureMethodExecutionInstance` fields link to the execution context. Results are

    captured in the `result` field. Test Orders can be associated with `Study` objects for

    clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations`

    for laboratory execution tracking.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'A Test Order represents an individual request to perform a specific test on a sample. Each

    Test Order references a `TestDefinition` that specifies what type of test to perform, and

    a `sample` (Entity) that is being tested. Test Orders track their lifecycle through `status`

    (see `TestStatus`), from PENDING when created, through IN_PROGRESS during execution, to

    COMPLETED or other terminal states. When executed via an Assay workflow, the `procedure`

    and `procedureMethodExecutionInstance` fields link to the execution context. Results are

    captured in the `result` field. Test Orders can be associated with `Study` objects for

    clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations`

    for laboratory execution tracking.'
  name: TestOrder
  x-bnch-organization: Benchling
paths:
  /test-order/items:
    get:
      description: List TestOrder items.
      operationId: TestOrder.List
      parameters:
      - $ref: '#/components/parameters/createdAt.gt'
      - $ref: '#/components/parameters/createdAt.gte'
      - $ref: '#/components/parameters/createdAt.lt'
      - $ref: '#/components/parameters/createdAt.lte'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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'
      - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.'
        in: query
        name: sort
        schema:
          default: modifiedAt:desc
          enum:
          - createdAt:asc
          - createdAt:desc
          - modifiedAt:asc
          - modifiedAt:desc
          type: string
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestOrderPaginatedList'
          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 TestOrder items
      tags:
      - TestOrder
      x-bnch-rate-limit-tier: 4
  /test-order/{test_order_id}:
    get:
      description: Get a single TestOrder by ID.
      operationId: TestOrder.Get
      parameters:
      - description: ID of the TestOrder.
        in: path
        name: test_order_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestOrder'
          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 TestOrder by ID
      tags:
      - TestOrder
      x-bnch-rate-limit-tier: 5
components:
  parameters:
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    createdAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: createdAt.gte
      schema:
        format: datetime
        type: string
    modifiedAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
      in: query
      name: modifiedAt.gt
      schema:
        format: datetime
        type: string
    modifiedAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: modifiedAt.lte
      schema:
        format: datetime
        type: string
    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
    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
    modifiedAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.
      in: query
      name: modifiedAt.lt
      schema:
        format: datetime
        type: string
    createdAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
      in: query
      name: createdAt.gt
      schema:
        format: datetime
        type: string
    createdAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.
      in: query
      name: createdAt.lt
      schema:
        format: datetime
        type: string
    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
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    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
    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
    modifiedAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: modifiedAt.gte
      schema:
        format: datetime
        type: string
    createdAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: createdAt.lte
      schema:
        format: datetime
        type: string
  responses:
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  schemas:
    ProcedureRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          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
    ProcedureMethodExecutionInstanceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    TestOrderPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/TestOrder'
          type: array
        nextToken:
          type: string
      type: object
    ContainerRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ResultRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    TestDefinitionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    GeneralError:
      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
    TestOrder:
      description: 'A Test Order represents an individual request to perform a specific test on a sample. Each

        Test Order references a `TestDefinition` that specifies what type of test to perform, and

        a `sample` (Entity) that is being tested. Test Orders track their lifecycle through `status`

        (see `TestStatus`), from PENDING when created, through IN_PROGRESS during execution, to

        COMPLETED or other terminal states. When executed via an Assay workflow, the `procedure`

        and `procedureMethodExecutionInstance` fields link to the execution context. Results are

        captured in the `result` field. Test Orders can be associated with `Study` objects for

        clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations`

        for laboratory execution tracking.'
      properties:
        __typename:
          type: string
        analysisComment:
          description: Additional comments provided for a test order with a status of blocked, invalid, or canceled.
          type:
          - 'null'
          - string
        container:
          description: The container associated with the sample being tested in this test order
          oneOf:
          - $ref: '#/components/schemas/ContainerRef'
          - type: 'null'
        createdAt:
          description: Timestamp of when the test order was created.
          format: datetime
          type: string
        dilutionFactor:
          description: The dilution factor of the test order.
          type:
          - 'null'
          - integer
        id:
          description: The ID of the test order.
          type: string
        modifiedAt:
          description: Timestamp of when the test order was last modified.
          format: datetime
          type: string
        name:
          description: The name of the test order.
          type: string
        procedure:
          description: 'The Assay (Procedure) for which this Test Order is created.

            Since a Test Definition can be used in multiple Assays, this association ensures clarity on which template should be followed for the specific Test Order.

            It is necessary to establish this association prior to the Assay Run to avoid ambiguity.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureRef'
          - type: 'null'
        procedureMethodExecutionInstance:
          description: 'The execution instance of the procedure method, linking the Test Order to the specific Assay Run to

            enable easy retrieval of all related Test Orders.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
          - type: 'null'
        result:
          description: The result of the test order.
          oneOf:
          - $ref: '#/components/schemas/ResultRef'
          - type: 'null'
        sample:
          $ref: '#/components/schemas/EntityRef'
          description: The sample being tested in this test order
        status:
          description: The status of the test order.
          enum:
          - PENDING
          - BLOCKED
          - IN_PROGRESS
          - CANCELLED
          - INVALID
          - COMPLETED
          type: string
        testDefinition:
          $ref: '#/components/schemas/TestDefinitionRef'
          description: The test definition associated with this test order.
      type: object
    EntityRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
  securitySchemes:
    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