---
title: "List worklists"
method: GET
path: "/worklists"
tags: ["worklists"]
---

# List worklists

`GET /worklists`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2-beta`
- URL: `https://{tenant_name}.benchling.com/api/v2-beta/worklists`
- Auth: HTTP bearer

List worklists. Individual items within a worklist are summarized.

## Query parameters

- `pageSize` integer
- `nextToken` string
- `sort` 'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc' | 'name' | 'name:asc' | 'name:desc'
- `modifiedAt` string
- `ids` string
- `worklistType` 'batch' | 'bioentity' | 'container' | 'plate': The type of items a worklist contains.
- `returning` string

## Response `200`

Returns a list of worklists. Items within the worklist are returned as summaries only.

- WorklistsPaginatedList: An object containing an array of Worklists
  - `nextToken` string
  - `worklists` Worklist[]
    - `apiURL` string, uri: The canonical url of the Worklist in the API.
    - `createdAt` string, date-time: Date and time the worklist was created
    - `creator` WorklistCreator: UserSummary of the user who created the worklist
      - `handle` string
      - `id` string
      - `name` string
    - `id` string: ID of the worklist
    - `modifiedAt` string, date-time: Date and time the worklist was last modified
    - `name` string: Name of the worklist
    - `type` 'batch' | 'bioentity' | 'container' | 'plate': The type of items a worklist contains.
    - `worklistItems` WorklistItemSummary[]
      - `id` string: ID of the item
      - `name` string: Name of the item

## Other responses

- `400`: Bad Request

---

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