Get Workflow
Fetch one workflow, including the full definition your team built and its summary.
Path
The workflow's id, from List Workflows.
Headers
Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.
Response fields
idstringUnique id of the workflow.
namestringThe name your team gave the workflow.
typestringThe workflow's type.
isActivebooleanTrue while the workflow is enabled and able to run.
isTemplatebooleanTrue if this is a template rather than a live workflow.
sizestringThe workflow's runner size: xs, sm, md, lg, xl, or xxl. Empty when sized automatically.
tagsarray of stringIds of the tags on the workflow. The tag catalog is managed in the app.
createdOndateWhen the workflow was created.
createdBystringWho created it.
updatedOndateWhen it was last changed.
updatedBystringWho last changed it.
workflowobjectThe full workflow definition your team built. Its shape depends on the workflow.
summaryobjectThe workflow's generated summary. Its shape depends on the workflow.