List worklist items

Beta

GET

https://{tenant_name}.benchling.com/api/v2-beta/worklists/:worklist_id/items

GET

/api/v2-beta/worklists/:worklist_id/items

curl https://{tenant_name}.benchling.com/api/v2-beta/worklists/worklist_id/items \
     -H "Authorization: Bearer <token>"

{
  "type": "container",
  "nextToken": "string",
  "worklistItems": [
    {
      "archiveRecord": {
        "reason": "Made in error"
      },
      "barcode": "string",
      "checkoutRecord": {
        "assignee": {
          "handle": "string",
          "id": "string",
          "name": "string"
        },
        "comment": "string",
        "modifiedAt": "2024-01-15T09:30:00Z",
        "status": "AVAILABLE"
      },
      "contents": [
        {
          "batch": {
            "archiveRecord": {
              "reason": "Made in error"
            },
            "createdAt": "2024-01-15T09:30:00Z",
            "creator": {
              "handle": "string",
              "id": "string",
              "name": "string"
            },
            "defaultConcentration": {
              "units": "string",
              "value": 1.1
            },
            "entity": {
              "entityType": "dna_sequence",
              "id": "seq_ObbdtGhC",
              "type": "string"
            },
            "fields": {},
            "id": "bat_UOIr8IjL",
            "modifiedAt": "2024-01-15T09:30:00Z",
            "name": "string",
            "schema": {
              "id": "string",
              "name": "string"
            },
            "webURL": "string"
          },
          "concentration": {
            "units": "string",
            "value": 1.1
          },
          "entity": {
            "aliases": [
              "string"
            ],
            "annotations": [
              {
                "color": "#F58A5E",
                "customFields": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "end": 1,
                "name": "string",
                "notes": "Cong et al Science. 2013 Jan 3.",
                "start": 1,
                "strand": 1,
                "type": "string"
              }
            ],
            "apiURL": "https://benchling.com/api/v2/dna-sequences/seq_asQya4lk",
            "archiveRecord": {
              "reason": "Made in error"
            },
            "authors": [
              {
                "handle": "string",
                "id": "string",
                "name": "string"
              }
            ],
            "bases": "string",
            "createdAt": "2024-01-15T09:30:00Z",
            "creator": {
              "handle": "string",
              "id": "string",
              "name": "string"
            },
            "customFields": {
              "Legacy ID": {
                "value": "STR100"
              }
            },
            "dnaAlignmentIds": [
              "string"
            ],
            "entityRegistryId": "string",
            "entityType": "dna_sequence",
            "fields": {},
            "folderId": "string",
            "id": "string",
            "isCircular": true,
            "length": 1,
            "modifiedAt": "2024-01-15T09:30:00Z",
            "name": "string",
            "parts": [
              {
                "end": 1,
                "sequenceId": "seq_VfVOART1",
                "start": 1,
                "strand": 1
              }
            ],
            "primers": [
              {
                "bases": "string",
                "bindPosition": 1,
                "color": "string",
                "end": 1,
                "name": "string",
                "oligoId": "string",
                "overhangLength": 1,
                "start": 1,
                "strand": 1
              }
            ],
            "registrationOrigin": {
              "originEntryId": "string",
              "registeredAt": "2024-01-15T09:30:00Z"
            },
            "registryId": "string",
            "schema": {
              "id": "string",
              "name": "string"
            },
            "transcriptions": [
              {
                "end": 1,
                "sequenceId": "seq_VfVOART1",
                "start": 1,
                "strand": 1
              }
            ],
            "translations": [
              {
                "aminoAcids": "string",
                "coerceStartCodonToMethionine": false,
                "color": "#F58A5E",
                "customFields": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "end": 1,
                "geneticCode": "STANDARD",
                "name": "string",
                "notes": "Cong et al Science. 2013 Jan 3.",
                "regions": [
                  {
                    "end": 1,
                    "start": 1
                  }
                ],
                "start": 1,
                "strand": 1
              }
            ],
            "url": "string",
            "webURL": "string"
          }
        }
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "creator": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "fields": {},
      "id": "con_ZBL9QQWD",
      "modifiedAt": "2024-01-15T09:30:00Z",
      "name": "string",
      "parentStorageId": "string",
      "parentStorageSchema": {
        "id": "string",
        "name": "string"
      },
      "projectId": "string",
      "quantity": {
        "units": "mL",
        "value": 10
      },
      "restrictedSampleParties": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "restrictionStatus": "RESTRICTED",
      "role": {
        "group": 1,
        "primaryRole": "SAMPLE",
        "subrole": "string"
      },
      "sampleOwners": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "schema": {
        "id": "string",
        "name": "string"
      },
      "volume": {
        "units": "mL",
        "value": 10
      },
      "webURL": "string"
    }
  ]
}

List items in a worklist. Items are ordered by their position within the worklist.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

worklist_idstringRequired

ID of the worklist

Query parameters

pageSizeintegerOptional0-100Defaults to 50

Number of results to return. Defaults to 50, maximum of 100.

nextTokenstringOptional

Token for pagination

Response headers

Result-Countinteger

The total number of items that match the given query

x-rate-limit-limitinteger

The number of allowed requests in the current rate-limit period

x-rate-limit-remaininginteger

The number of requests remaining in the current rate-limit period

x-rate-limit-resetinteger

The number of seconds remaining in the current rate-limit period

Response

Returns a list of items within the worklist.

batchobject

bioentityobject

containerobject

plateobject

Errors

400

Bad Request Error