BEbenchling
worklists

Get a worklist by ID

Get a worklist by ID

get/worklists/{worklist_id}

Request

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

Path parameters

worklist_idstring required

ID of the worklist

Query parameters

returningstring

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

Returns a single worklist. Items within the worklist are returned as summaries only.

apiURLstring uri

The canonical url of the Worklist in the API.

createdAtstring date-time

Date and time the worklist was created

idstring

ID of the worklist

modifiedAtstring date-time

Date and time the worklist was last modified

namestring

Name of the worklist

type'batch' | 'bioentity' | 'container' | 'plate'

The type of items a worklist contains.

Changes

No recorded changes to this operation across all 1 revision of this API.