--- title: "List worklist items" method: GET path: "/worklists/{worklist_id}/items" tags: ["worklists"] --- # List worklist items `GET /worklists/{worklist_id}/items` ## Request - Base URL: `https://{tenant_name}.benchling.com/api/v2-beta` - URL: `https://{tenant_name}.benchling.com/api/v2-beta/worklists/{worklist_id}/items` - Auth: HTTP bearer List items in a worklist. Items are ordered by their position within the worklist. ## Path parameters - `worklist_id` string, required ## Query parameters - `pageSize` integer - `nextToken` string ## Response `200` Returns a list of items within the worklist. - union: An object containing an ordered set of Worklist Items - object: batch variant - `type` 'batch', required: Discriminator value: batch - `nextToken` string - `worklistItems` Batch[] - `archiveRecord` ArchiveRecord - `reason` string - `createdAt` string, date-time: DateTime at which the the result was created - `creator` UserSummary - `handle` string - `id` string - `name` string - `defaultConcentration` Measurement - `units` string, nullable, required: Can only be null if value is also null - `value` number, double, nullable, required: Can only be null if units is also null - `entity` union - object: aa_sequence variant - `entityType` 'aa_sequence', required: Discriminator value: aa_sequence - `id` string - `type` string - object: custom_entity variant - `entityType` 'custom_entity', required - `id` string - `type` string - object: dna_sequence variant - `entityType` 'dna_sequence', required - `id` string - `type` string - `fields` Fields - `id` string - `modifiedAt` string, date-time - `name` string - `schema` SchemaSummary - `id` string - `name` string - `webURL` string - object: bioentity variant - `type` 'bioentity', required: Discriminator value: bioentity - `nextToken` string - `worklistItems` GenericEntity[] - `aliases` string[] - `apiURL` string - `archiveRecord` ArchiveRecord - `reason` string - `authors` UserSummary[]: Array of UserSummary Resources of the authors of the entity. This defaults to the creator but can be manually changed. - `handle` string - `id` string - `name` string - `createdAt` string, date-time - `creator` GenericEntityCreator: UserSummary of the user who created the Legacy Request - `handle` string - `id` string - `name` string - `customFields` CustomFields - `entityRegistryId` string, nullable - `fields` Fields - `folderId` string - `id` string - `modifiedAt` string, date-time - `name` string - `registrationOrigin` RegistrationOrigin - `originEntryId` string, nullable - `registeredAt` string, date-time - `registryId` string, nullable - `schema` SchemaSummary - `id` string - `name` string - `webURL` string - object: container variant - `type` 'container', required: Discriminator value: container - `nextToken` string - `worklistItems` Container[] - `archiveRecord` ArchiveRecord - `reason` string - `barcode` string, nullable - `checkoutRecord` CheckoutRecord: *assignee field* is set if status is "RESERVED" or "CHECKED_OUT", or null if status is "AVAILABLE". *comment field* is set when container was last reserved, checked out, or checked into. *modifiedAt field* is the date and time when container was last checked out, checked in, or reserved - `assignee` union - UserSummary - `handle` string - `id` string - `name` string - TeamSummary - `id` string - `name` string - `comment` string - `modifiedAt` string, date-time - `status` 'AVAILABLE' | 'RESERVED' | 'CHECKED_OUT' - `contents` ContainerContent[] - `batch` union - Batch - `archiveRecord` ArchiveRecord - … - `createdAt` string, date-time: DateTime at which the the result was created - `creator` UserSummary - … - `defaultConcentration` Measurement - … - `entity` union - … - `fields` Fields - `id` string - `modifiedAt` string, date-time - `name` string - `schema` SchemaSummary - … - `webURL` string - InaccessibleResource - `inaccessibleId` string - `type` string: The type of this inaccessible item. Example values: "custom_entity", "container", "plate", "dna_sequence" - `concentration` Measurement - `units` string, nullable, required: Can only be null if value is also null - `value` number, double, nullable, required: Can only be null if units is also null - `entity` union - union - object: aa_sequence variant - … - object: custom_entity variant - … - object: dna_oligo variant - … - object: dna_sequence variant - … - object: mixture variant - … - object: molecule variant - … - object: rna_oligo variant - … - object: rna_sequence variant - … - InaccessibleResource - `inaccessibleId` string - `type` string: The type of this inaccessible item. Example values: "custom_entity", "container", "plate", "dna_sequence" - `createdAt` string, date-time - `creator` UserSummary - `handle` string - `id` string - `name` string - `fields` Fields - `id` string - `modifiedAt` string, date-time - `name` string - `parentStorageId` string, nullable - `parentStorageSchema` SchemaSummary - `id` string - `name` string - `projectId` string, nullable - `quantity` ContainerQuantity: Quantity of a container, well, or transfer. Supports mass, volume, and other quantities. - `units` 'L' | 'mL' | 'uL' | 'nL' | 'pL' | 'gal (US)' | 'qt (US)' | 'pt (US)' | 'kg' | 'g' | 'mg' | 'ug' | 'ng' | 'pg' | 'lb' | 'oz' | 'mol' | 'mmol' | 'umol' | 'nmol' | 'pmol' | 'cells' | '(x10^3) cells' | '(x10^4) cells' | '(x10^5) cells' | '(x10^6) cells' | '(x10^7) cells' | '(x10^8) cells' | '(x10^9) cells' | 'items' | 'units' - `value` number, double, nullable - `restrictedSampleParties` ContainerRestrictedSamplePartiesItems[] - union - UserSummary - `handle` string - `id` string - `name` string - TeamSummary - `id` string - `name` string - `restrictionStatus` 'RESTRICTED' | 'UNRESTRICTED' | 'NOT_APPLICABLE' - `role` ExperimentalWellRole - `group` integer - `primaryRole` 'SAMPLE' | 'CONTROL' | 'STANDARD' | 'BLANK' - `subrole` string, nullable - `sampleOwners` ContainerSampleOwnersItems[] - union - UserSummary - `handle` string - `id` string - `name` string - TeamSummary - `id` string - `name` string - `schema` SchemaSummary - `id` string - `name` string - `volume` DeprecatedContainerVolumeForResponse: The deprecated "volume" type key in API responses can also contain non-volume quantities for back-compatibility purposes. Use the "quantity" type key instead. - `units` 'L' | 'mL' | 'uL' | 'nL' | 'pL' | 'gal (US)' | 'qt (US)' | 'pt (US)' | 'kg' | 'g' | 'mg' | 'ug' | 'ng' | 'pg' | 'lb' | 'oz' | 'mol' | 'mmol' | 'umol' | 'nmol' | 'pmol' | 'cells' | '(x10^3) cells' | '(x10^4) cells' | '(x10^5) cells' | '(x10^6) cells' | '(x10^7) cells' | '(x10^8) cells' | '(x10^9) cells' | 'items' | 'units' - `value` number, double, nullable - `webURL` string - object: plate variant - `type` 'plate', required: Discriminator value: plate - `nextToken` string - `worklistItems` Plate[] - `archiveRecord` ArchiveRecord - `reason` string - `availableCapacity` integer, nullable: The number of available positions in a matrix plate. Null for well plates. - `barcode` string, nullable: Barcode of the plate - `createdAt` string, date-time: DateTime the container was created - `creator` UserSummary - `handle` string - `id` string - `name` string - `fields` Fields - `id` string: ID of the plate - `modifiedAt` string, date-time: DateTime the plate was last modified - `name` string: Name of the plate, defaults to barcode if name is not provided. - `occupiedCapacity` integer, nullable: The number of containers currently in a matrix plate. Null for well plates. - `parentStorageId` string, nullable: ID of containing parent inventory (e.g. loc_k2lNspzS). - `projectId` string, nullable: ID of the project if set - `schema` SchemaSummary - `id` string - `name` string - `totalCapacity` integer, nullable: The total capacity of a matrix plate (i.e. how many containers it can store). Null for well plates. - `type` 'matrix_plate' | 'well_plate' - `webURL` string - `wells` object: Well contents of the plate, keyed by position string (eg. "A1"). ## 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)