List Legacy Requests

GET

https://{tenant_name}.benchling.com/api/v2/requests

GET

/api/v2/requests

curl -G https://{tenant_name}.benchling.com/api/v2/requests \
     -H "Authorization: Bearer <token>" \
     -d nextToken=Im5ldyB0ZXN0Ig \
     -d schemaId=schemaId

200Retrieved

{
  "requests": [
    {
      "apiURL": "https://benchling.com/api/v2/requests/req_dnn2JtWq",
      "assignees": [
        {
          "user": {
            "handle": "string",
            "id": "string",
            "name": "string"
          }
        }
      ],
      "createdAt": {},
      "creator": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "displayId": "VP1",
      "fields": {},
      "id": "req_JekfeyVS",
      "projectId": "src_29pt8Ida",
      "requestStatus": "REQUESTED",
      "requestor": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "sampleGroups": [
        {
          "id": "sgrp_YJKtcWV",
          "samples": {
            "Batch Example": {
              "batchId": "bat_XK0UnLyk"
            },
            "Entity Example": {
              "containerId": "ctn_urUAEBq",
              "entityId": "seq_nDtxYEs"
            }
          }
        }
      ],
      "scheduledOn": {},
      "schema": {
        "id": "string",
        "name": "string"
      },
      "tasks": [
        {
          "id": "reqtsk_PFHQ8rmb",
          "fields": {},
          "sampleGroupIds": [
            "string"
          ],
          "schema": {
            "id": "string",
            "name": "string"
          }
        }
      ],
      "webURL": "https://benchling.com/requests/req_JekfeyVS"
    }
  ],
  "nextToken": "string"
}

List Legacy Requests

Authentication

AuthorizationBearer

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

Query parameters

schemaIdstringRequired

requestStatusenumOptional

Allowed values:

minCreatedTimeintegerOptional

minimum create time (unix seconds)

maxCreatedTimeintegerOptional

maximum create time (unix seconds)

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Response

requestslist of objectsOptional

nextTokenstringOptional