> 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 ProcedureParameterVersion items

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

List ProcedureParameterVersion items.

Reference: https://docs.benchling.com/docs/api/benchling-api/procedure-parameter-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.
- `creator.anyOf` (string, optional) — Restricts results to those created by any of the specified user IDs. Comma-separated list.
- `id.anyOf` (string, optional) — Restricts results to those matching any of the specified IDs. Comma-separated list.
- `libraryParameterDefinition.anyOf` (string, optional) — Restricts results to parameter versions linked to any of the specified library parameter definition 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.
- `procedureParameter.eq` (string, optional) — ID of a procedure parameter. Restricts results to children of the specified parameter.
- `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 ProcedureParameterVersion, optional)
- `nextToken` (string, optional)

## Errors

### 400 Procedure Parameter 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 Parameter 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 Parameter 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 Parameter 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 Parameter 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

### ProcedureParameterVersion

A versioned definition of a procedure parameter. Each version specifies the parameter's name, description, data type configuration (`dataType`), and how values are entered (`confirmationMethod`). Parameters are versioned to allow procedure templates to evolve while preserving the exact configuration used in past executions. Links to its parent `ProcedureParameter` for identity. For data parameters, `minimum` and `maximum` fields define optional numeric bounds. For material inputs, `amountDataType` configures how quantities are specified. For equipment parameters, `allowedEquipmentModels` restricts which equipment can be selected. May reference a `LibraryParameterDefinition` when the parameter was created from the parameter library.

- `__typename` (string, optional)
- `allowedEquipmentModels` (map from string to any, optional, nullable)
- `amountDataType` (ProcedureParameterDataType, optional, nullable) — Specifies the value type configuration for a procedure parameter. Used within `ProcedureParameterVersion` to define what kind of data a parameter accepts. The `type` field indicates the field type (such as text, decimal, entity link, or dropdown). For numeric types, `unit` optionally references a `Unit` for measurement context. For entity link types, `schema` optionally constrains values to entities of a specific `EntitySchema`. Also used as `amountDataType` on material input parameter versions to define how amounts are specified.
- `confirmationMethod` (enum, optional)
  - Allowed values: `TABLE`, `PLATE_MAP`
- `createdAt` (string, optional)
- `creator` (PrincipalRef, optional)
- `dataType` (ProcedureParameterDataType, optional) — Specifies the value type configuration for a procedure parameter. Used within `ProcedureParameterVersion` to define what kind of data a parameter accepts. The `type` field indicates the field type (such as text, decimal, entity link, or dropdown). For numeric types, `unit` optionally references a `Unit` for measurement context. For entity link types, `schema` optionally constrains values to entities of a specific `EntitySchema`. Also used as `amountDataType` on material input parameter versions to define how amounts are specified.
- `description` (string, optional)
- `id` (string, optional)
- `maximum` (map from string to any, optional, nullable)
- `minimum` (map from string to any, optional, nullable)
- `name` (string, optional)
- `procedureParameter` (ProcedureParameterRef, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### ProcedureParameterDataType

Specifies the value type configuration for a procedure parameter. Used within `ProcedureParameterVersion` to define what kind of data a parameter accepts. The `type` field indicates the field type (such as text, decimal, entity link, or dropdown). For numeric types, `unit` optionally references a `Unit` for measurement context. For entity link types, `schema` optionally constrains values to entities of a specific `EntitySchema`. Also used as `amountDataType` on material input parameter versions to define how amounts are specified.

- `__typename` (string, optional)
- `dropdown` (DropdownRef, optional, nullable)
- `schema` (EntitySchemaRef, optional, nullable)
- `type` (string, optional)
- `unit` (UnitRef, optional, nullable)

### PrincipalRef

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

### ProcedureParameterRef

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

### DropdownRef

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

### EntitySchemaRef

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

### UnitRef

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

## Examples

**Response**

```json
{
  "items": [
    {
      "__typename": "__typename",
      "allowedEquipmentModels": {
        "key": "value"
      },
      "confirmationMethod": "TABLE",
      "createdAt": "createdAt",
      "description": "description",
      "id": "id",
      "maximum": {
        "key": "value"
      },
      "minimum": {
        "key": "value"
      },
      "name": "name"
    }
  ],
  "nextToken": "nextToken"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/procedure-parameter-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-parameter-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);
}
```