Get Workflow

The Get Workflow task retrieves the details of a workflow execution using its workflow ID.

note

You can get the workflow details only if you have at least read permission for the workflow. Otherwise, the workflow will fail with an error message like this:

Task configuration

Configure these parameters for the Get Workflow task.

Parameter	Description	Required/ Optional
inputParameters. id	The workflow ID of the workflow to be retrieved. It can be passed as a variable.	Required.
inputParameters. includeTasks	Whether to retrieve the task details or not. The default value is false.	Required.

Task definition

This is the JSON schema for a Get Workflow task definition.

{
  "name": "get_workflow",
  "taskReferenceName": "get_workflow_ref",
  "inputParameters": {
    "id": "e27cf59c-0851-11ef-9a82-c62f15439f28",
    "includeTasks": true
  },
  "type": "GET_WORKFLOW"
}

Task output

The Get Workflow task will return all the details of the retrieved workflow. View an example here.

Adding a Get Workflow task in UI

To add a Get Workflow task:

1. In your workflow, select the (+) icon and add a Get Workflow task.
2. Enter the Workflow ID.
3. (Optional) Check Include tasks if needed.