--- title: "List workflow task groups" method: GET path: "/workflow-task-groups" tags: ["workflowTaskGroups"] --- # List workflow task groups `GET /workflow-task-groups` ## Request - Base URL: `https://{tenant_name}.benchling.com/api/v2` - URL: `https://{tenant_name}.benchling.com/api/v2/workflow-task-groups` - Auth: HTTP bearer List workflow task groups ## Query parameters - `ids` string - `schemaId` string - `folderId` string - `projectId` string - `mentionedIn` string - `watcherIds` string - `executionTypes` string - `responsibleTeamIds` string - `statusIds.anyOf` string - `statusIds.noneOf` string - `statusIds.only` string - `name` string - `nameIncludes` string - `creatorIds` string - `modifiedAt` string - `nextToken` string - `pageSize` integer - `displayIds` string - `archiveReason` string ## Response `200` OK - WorkflowTaskGroupsPaginatedList - `nextToken` string - `workflowTaskGroups` WorkflowTaskGroup[] - `displayId` string: User-friendly ID of the workflow task group - `id` string: The ID of the workflow task group - `name` string: The name of the workflow task group - `archiveRecord` ArchiveRecord - `reason` string - `createdAt` string: The ISO formatted date and time that the task group was created - `creationOrigin` CreationOrigin - `application` string, nullable - `originId` string, nullable - `originModalUuid` string, uuid, nullable - `originType` string, nullable - `creator` UserSummary - `handle` string - `id` string - `name` string - `folder` Folder - `archiveRecord` ArchiveRecord - `reason` string - `id` string - `name` string - `parentFolderId` string, nullable: ID of the parent folder, if it exists - `projectId` string: ID of the containing project - `modifiedAt` string: The ISO formatted date and time that the task group was last modified - `outputs` WorkflowOutputSummary[]: The outputs of the workflow task group - `displayId` string: User-friendly ID of the workflow task group - `id` string: The ID of the workflow output - `responsibleTeam` TeamSummary - `id` string - `name` string - `watchers` UserSummary[]: The users watching the workflow task group - `handle` string - `id` string - `name` string - `webURL` string, uri: URL of the workflow task group - `workflowTaskSchema` WorkflowTaskSchemaSummary - `id` string: The ID of the workflow task schema - `name` string: The name of the workflow task schema - `workflowTasks` WorkflowTaskSummary[]: The input tasks to the workflow task group - `displayId` string: User-friendly ID of the workflow task - `id` string: The ID of the workflow task - `executionType` 'DIRECT' | 'ENTRY' | 'FLOWCHART' | 'PROCEDURE' | 'PROCEDURE_METHOD' | 'PROCEDURE_STEP': The method by which the workflow is executed - `flowchartConfigVersionId` string: The flowchart configuration that this task group uses. This will be null if the task group does not have executionType FLOWCHART. - `flowchartTaskGroups` WorkflowNodeTaskGroupSummary[]: The task groups that are members of the flowchart that this task group is the root of. This will be null this task group is not the root task group of a flowchart (eg if the task group does not have executionType FLOWCHART). - `displayId` string: User-friendly ID of the workflow task group - `id` string: The ID of the workflow task group - `name` string: The name of the workflow task group - `nodeConfigId` string: The node in a Flowchart that this task group is associated with. This will be null if the task group is not part of a flowchart. - `nodeConfig` WorkflowFlowchartNodeConfig - `id` string: The ID of the workflow flowchart node config - `nodeDetails` union - object: END variant - `nodeType` 'END', required: Discriminator value: END - `id` string: The ID of the workflow flowchart end node config details - `name` string: The name of the end node - object: OUTPUT variant - `nodeType` 'OUTPUT', required: The type of the node - `id` string: The ID of the workflow output node config details - `outputSchema` SchemaSummary - `id` string - `name` string - object: ROOT variant - `nodeType` 'ROOT', required: The type of the node - `id` string: The ID of the workflow root node config details - `rootTaskSchema` WorkflowTaskSchemaSummary - `id` string: The ID of the workflow task schema - `name` string: The name of the workflow task schema - object: ROUTER variant - `nodeType` 'ROUTER', required: The type of the node - `id` string: The ID of the workflow router node config details - `name` string: The name of the router node - `routerFunctions` WorkflowRouterFunction[]: Router functions associated with this router node - `edgeConfigId` string: The ID of the workflow flowchart edge config associated with this function - `id` string: The function associated with a router node - `isDefault` unknown - `name` string: The name of a function associated with a router node - object: TASK variant - `nodeType` 'TASK', required: The type of the node - `id` string: The ID of the workflow task node config details - `taskSchema` WorkflowTaskSchemaSummary - `id` string: The ID of the workflow task schema - `name` string: The name of the workflow task schema - `nodeType` 'ROOT' | 'OUTPUT' | 'TASK' | 'ROUTER' | 'END': The type associated with the node config - `rootTaskGroup` WorkflowTaskGroupSummary - `displayId` string: User-friendly ID of the workflow task group - `id` string: The ID of the workflow task group - `name` string: The name of the workflow task group - `workflowOutputs` WorkflowOutputSummary[]: The outputs of the workflow task group - `displayId` string: User-friendly ID of the workflow task group - `id` string: The ID of the workflow output ## Other responses - `400`: Bad request --- [API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)