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

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

List ProcedureParameterPlannedValue items.

Reference: https://docs.benchling.com/docs/api/benchling-api/procedure-parameter-planned-value/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.
- `methodExecutionInstance.anyOf` (string, optional) — Restricts results to only those that are part of procedure method execution instances matching any of the specified procedure method execution instance IDs. Comma-separated list.
- `modifiedAt.gt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
- `modifiedAt.gte` (string, optional) — 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.
- `modifiedAt.lt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. \< 2017-04-30.
- `modifiedAt.lte` (string, optional) — 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.
- `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.
- `parameterVersion.anyOf` (string, optional) — Restricts results to those that are children of procedure parameter versions matching any of the specified procedure parameter version IDs. Comma-separated list.
- `returning` (string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `sort` (enum, optional, default: modifiedAt:desc) — 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.
  - Allowed values: `createdAt:asc`, `createdAt:desc`, `modifiedAt:asc`, `modifiedAt:desc`

### Headers

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

## Response

### 200

OK

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

## Errors

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

### ProcedureParameterPlannedValue

Stores the expected or planned value for a parameter, set during procedure setup or run planning. Used to specify anticipated inputs before execution begins—for example, the target concentration for a reagent, the expected sample to use, or the equipment to employ. Scientists can later confirm these values (`ProcedureParameterConfirmationValue`) during execution or record actual results (`ProcedureParameterMeasuredValue`). For material inputs, `amount` and `container` fields specify planned quantities and storage locations. Links to `ProcedureParameterVersion` for the parameter definition and optionally to a `ProcedureMethodExecutionInstance` when associated with a specific run.

- `__typename` (string, optional)
- `amount` (map from string to any, optional, nullable)
- `container` (map from string to any, optional, nullable)
- `createdAt` (string, optional)
- `creator` (PrincipalRef, optional)
- `id` (string, optional)
- `methodExecutionInstance` (ProcedureMethodExecutionInstanceRef, optional, nullable)
- `modifiedAt` (string, optional)
- `parameterVersion` (ProcedureParameterVersionRef, optional)
- `plateWellAssociations` (list of ProcedureParameterValueLinkedPlateWell, optional)
- `value` (map from string to any, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### PrincipalRef

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

### ProcedureMethodExecutionInstanceRef

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

### ProcedureParameterVersionRef

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

### ProcedureParameterValueLinkedPlateWell

Associates a parameter value with a specific well on a laboratory plate. Used within `ProcedureParameterPlannedValue`, `ProcedureParameterConfirmationValue`, and `ProcedureParameterMeasuredValue` via the `plateWellAssociations` field. Enables plate map integrations where parameter values correspond to individual wells. The `plateId` references the plate (Plate, MatrixPlate, or WellPlate), and `wellPosition` specifies the alphanumeric coordinate (such as "A1" or "B19").

- `__typename` (string, optional)
- `plateId` (string, optional)
- `wellPosition` (string, optional) — Alphanumeric position of plate well eg. A1, B19

## Examples

**Response**

```json
{
  "items": [
    {
      "__typename": "__typename",
      "amount": {
        "key": "value"
      },
      "container": {
        "key": "value"
      },
      "createdAt": "createdAt",
      "id": "id",
      "modifiedAt": "modifiedAt",
      "plateWellAssociations": [
        {}
      ],
      "value": {
        "key": "value"
      }
    }
  ],
  "nextToken": "nextToken"
}
```

**SDK Code**

```python
import requests

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