---
title: "List WellPlatePosition items"
method: GET
path: "/api/v3/well-plate-position/items"
tags: ["Well Plate Position"]
---

# List WellPlatePosition items

`GET /api/v3/well-plate-position/items`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/well-plate-position/items`
- Auth: HTTP bearer

List WellPlatePosition items.

## Query parameters

- `createdAt.gt` string, datetime
- `createdAt.gte` string, datetime
- `createdAt.lt` string, datetime
- `createdAt.lte` string, datetime
- `id.anyOf` string[]
- `modifiedAt.gt` string, datetime
- `modifiedAt.gte` string, datetime
- `modifiedAt.lt` string, datetime
- `modifiedAt.lte` string, datetime
- `name.anyOf` string[]
- `name.anyOf.caseSensitive` string[]
- `nextToken` string
- `omit` string[]
- `pageSize` integer
- `returning` string[]
- `sort` 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt:asc' | 'modifiedAt:desc'

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- WellPlatePositionPaginatedList
  - `items` WellPlatePosition[]
    - `contents` ContainerContent[]: Well contents of the well plate.
      - `__typename` string
      - `concentration` Measurement: Represents a quantity with an associated unit of measurement within Benchling's inventory system. Measurements are used throughout inventory to track container volumes, sample masses, concentrations, and other quantitative values. Each Measurement pairs a numeric value with a Unit (see Unit) to provide context-aware quantity handling. For example, a container might have a Measurement of 500 uL for its volume. Unlike ContainerQuantity which provides a simpler representation, Measurement supports the full Unit system with dimensional conversions.
        - `__typename` string
        - `unit` UnitRef
          - `__typename` string
          - `id` string, api_id
        - `value` number, double, nullable
      - `createdAt` string, datetime: When the container was first filled with this entity.
      - `entity` EntityRef
        - `__typename` string
        - `id` string, api_id
      - `modifiedAt` string, datetime: When the entity was last added to this container or the concentration was last changed.
    - `coordinates` GridCoordinates: Read model representing a fillable position in a box or plate.
      - `__typename` string
      - `column` integer: The 0-indexed column index of the position
      - `index` integer: The 1-indexed position determined by counting across rows. For example, for a six-well plate: +---+---+---+ | 1 | 2 | 3 | +---+---+---+ | 4 | 5 | 6 | +---+---+---+
      - `position` string: The alphanumeric position, where rows are indexed alphabetically and columns are indexed numerically, starting from "A1"
      - `row` integer: The 0-indexed row index of the position
    - `createdAt` string, datetime: When the well plate was created.
    - `expirationInfo` ExpirationInfo: Provides expiration tracking for inventory items such as containers and their contents. The expirationDate may be explicitly set on the container or inherited from the stored entity's properties. The isExpired flag is a computed convenience field that returns true if the current date is past the expiration date. Items without an expiration date are considered non-expiring (isExpired returns false).
      - `__typename` string
      - `expirationDate` string, datetime, nullable: Expiration date of the item, potentially inherited from the contents or overridden.
      - `isExpired` boolean: Whether the item is past its expiration date. Items without an expiration date return False.
    - `id` string: The ID of the container representing the well at this plate position.
    - `modifiedAt` string, datetime: When the well plate was last modified.
    - `name` string: The name of the container representing the well at this position.
    - `quantity` Measurement: Represents a quantity with an associated unit of measurement within Benchling's inventory system. Measurements are used throughout inventory to track container volumes, sample masses, concentrations, and other quantitative values. Each Measurement pairs a numeric value with a Unit (see Unit) to provide context-aware quantity handling. For example, a container might have a Measurement of 500 uL for its volume. Unlike ContainerQuantity which provides a simpler representation, Measurement supports the full Unit system with dimensional conversions.
      - `__typename` string
      - `unit` UnitRef
        - `__typename` string
        - `id` string, api_id
      - `value` number, double, nullable
    - `role` ExperimentalRole: Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate group number, and optional subrole. The group field identifies replicate sets: wells with the same primary role and group number are treated as technical replicates for statistical analysis. The subrole field provides additional categorization for controls (e.g., POSITIVE, NEGATIVE, MAXIMUM, MINIMUM); only CONTROL primary roles may have subroles. ExperimentalRole is used in plate-based workflows to define experimental layouts (see PlateMapPosition) and annotate wells in FixedPlate and Container objects.
      - `__typename` string
      - `group` integer: Role group (aka replicate id)
      - `primaryRole` 'CONTROL' | 'SAMPLE' | 'BLANK' | 'STANDARD': Primary role
      - `subrole` string, nullable: Subrole, used to differentiate different sub types of a role (e.g. positive control)
    - `schema` ContainerSchemaRef
      - `__typename` string
      - `id` string, api_id
  - `nextToken` string, nullable

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/3873a10bf7b8?raw)