> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# List ProcedureMethodDefinitionVersion items

GET https://{tenant_name}.benchling.com/api/v3/procedure-method-definition-version/items

List ProcedureMethodDefinitionVersion items.

Reference: https://docs.benchling.com/docs/api/benchling-api/procedure-method-definition-version/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `createdAt.gt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
- `createdAt.gte` (string, optional) — 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.
- `createdAt.lt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. \< 2017-04-30.
- `createdAt.lte` (string, optional) — 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.
- `id.anyOf` (string, optional) — Restricts results to those matching any of the specified IDs. Comma-separated list.
- `name.anyOf` (string, optional) — 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.
- `name.anyOf.caseSensitive` (string, optional) — 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.
- `nextToken` (string, optional) — Token for pagination
- `omit` (string, optional) — Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
- `pageSize` (integer, optional) — Number of results to return. Defaults to 50, maximum of 100.
- `returning` (string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `sort` (enum, optional, default: createdAt:desc) — Method by which to order results. Valid sorts are: createdAt (created time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is createdAt:desc.
  - Allowed values: `createdAt:asc`, `createdAt:desc`

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

## Response

### 200

OK

- `items` (list of ProcedureMethodDefinitionVersion, optional)
- `nextToken` (string, optional)

## Errors

### 400 Procedure Method Definition Version List Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Procedure Method Definition Version List Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Procedure Method Definition Version List Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Procedure Method Definition Version List Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Procedure Method Definition Version List Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### ProcedureMethodDefinitionVersion

A versioned method within a procedure flowchart. Methods are the building blocks of procedures, representing discrete experimental operations that scientists perform. Each method contains step groups (see `stepGroups` and `ProcedureStepGroup`) organized by execution phase, along with parameter settings for data collection (`dataParameterSettings`), material inputs (`materialInputSettings`), material outputs (`materialOutputSettings`), and equipment (`equipmentSettings`). Methods appear as nodes in the procedure flowchart (see `ProcedureFlowchartConfigVersion`) and are connected by edges that define execution order and material flow. ## Product mapping - In the Benchling product experience, this maps to a **method, or unit operation** in the procedure graph. - This type is the versioned template/configuration shape; runtime execution state is captured by `ProcedureMethodExecutionInstance`.

- `__typename` (string, optional)
- `createdAt` (string, optional)
- `dataParameterSettings` (list of ProcedureDataParameterSetting, optional)
- `description` (string, optional)
- `equipmentSettings` (list of ProcedureEquipmentSetting, optional)
- `id` (string, optional)
- `materialInputSettings` (list of ProcedureMaterialInputSetting, optional)
- `materialOutputSettings` (list of ProcedureMaterialOutputSetting, optional)
- `name` (string, optional)
- `nodeId` (string, optional)
- `stepGroups` (list of ProcedureStepGroup, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### ProcedureDataParameterSetting

Configures a data parameter within a method, linking a parameter definition (`ProcedureParameterVersion`) with its planned values. Data parameters capture experimental measurements or observations during procedure execution.

- `__typename` (string, optional)
- `values` (list of ProcedureParameterPlannedValueRef, optional)
- `version` (ProcedureParameterVersionRef, optional)

### ProcedureEquipmentSetting

Configures equipment usage within a method, linking a parameter definition (`ProcedureParameterVersion`) with its planned values. Equipment settings specify instruments or devices required to perform the method step.

- `__typename` (string, optional)
- `values` (list of ProcedureParameterPlannedValueRef, optional)
- `version` (ProcedureParameterVersionRef, optional)

### ProcedureMaterialInputSetting

Configures a material input within a method, linking a parameter definition (`ProcedureParameterVersion`) with its planned values. Material inputs specify reagents, samples, or other substances consumed by the method step.

- `__typename` (string, optional)
- `values` (list of ProcedureParameterPlannedValueRef, optional)
- `version` (ProcedureParameterVersionRef, optional)

### ProcedureMaterialOutputSetting

Configures a material output within a method, linking to a parameter definition (`ProcedureParameterVersion`). Material outputs specify products or intermediates produced by the method step that can flow to subsequent methods via material edges.

- `__typename` (string, optional)
- `version` (ProcedureParameterVersionRef, optional)

### ProcedureStepGroup

Groups procedure steps by their execution phase within a method. Each method contains multiple step groups (see `ProcedureStepGroupType`), and each group contains an ordered list of steps (see `steps` and `ProcedureStepDefinitionVersion`) to be executed in sequence.

- `__typename` (string, optional)
- `group` (enum, optional)
  - Allowed values: `PRE_RUN`, `RUN`, `POST_RUN`
- `steps` (list of ProcedureStepDefinitionVersionRef, optional)

### ProcedureParameterPlannedValueRef

- `__typename` (string, optional)
- `id` (string, optional)

### ProcedureParameterVersionRef

- `__typename` (string, optional)
- `id` (string, optional)

### ProcedureStepDefinitionVersionRef

- `__typename` (string, optional)
- `id` (string, optional)

## Examples

**Response**

```json
{
  "items": [
    {
      "__typename": "__typename",
      "createdAt": "createdAt",
      "dataParameterSettings": [
        {}
      ],
      "description": "description",
      "equipmentSettings": [
        {}
      ],
      "id": "id",
      "materialInputSettings": [
        {}
      ],
      "materialOutputSettings": [
        {}
      ],
      "name": "name",
      "nodeId": "nodeId",
      "stepGroups": [
        {}
      ]
    }
  ],
  "nextToken": "nextToken"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/procedure-method-definition-version/items"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/procedure-method-definition-version/items';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```