Skip to main content

​
MCP tool: get_all_workflows

Retrieves a paginated list of all workflows defined by the organization. This tool supports filtering by team, type, and sub-types, along with pagination for efficient data retrieval.

​
Example prompt

Get all workflows for team TEAM001 with type "WORKFLOW"

​
Input parameters

NameTypeRequiredDescription
teamIdstringNoThe team ID to fetch workflows for
pagenumberNoThe page number to fetch workflows by
limitnumberNoThe limit of workflows to fetch
typestringNoThe type of workflows to fetch
subTypesstringNoComma separated sub types of workflows to fetch (e.g., “WORKFLOW,AI_AGENT”)

​
Response fields

Below are the fields you may see in each workflow object in the response:
FieldTypeDescription
uidstringUnique identifier for current version of the workflow
typestringThe type of the workflow
subTypestringThe sub type of the workflow
uniqueIdentifierstringThe unique identifier of the workflow
namestringThe name identifier of the workflow
versionnumberThe version of the workflow
triggerEventobjectThe trigger event of the workflow
filtersobjectThe filters of the workflow
annotationsarrayThe annotation for the workflow
workflowDefinitionarrayThe workflow definition steps
executingAgentstringThe executing agent of the workflow
isActivebooleanThe status of the workflow
createdAtstring (ISO8601)The created at date of the workflow
updatedAtstring (ISO8601)The updated at date of the workflow
createdBystringThe created by of the workflow
teamIdstringThe team id of the workflow
metadataobjectThe metadata for the workflow

​
Workflow step structure

Each step in the workflowDefinition array contains:
FieldTypeDescription
stepIdentifiernumberThe step identifier of the workflow step
activityobjectThe activity of the workflow step
inputobjectThe input to the activity
retryPolicyobjectThe retry policy of the activity
onFailurestringThe action to take on failure (CONTINUE, ABORT, COMPENSATE)
isSleepActivitybooleanWhether the activity is a sleep activity
executionTimeoutnumberThe execution timeout of the activity
approverobjectThe approver of the activity
dependenciesarrayThe dependencies of the activity
filtersobjectThe filters of the activity
compensationActivityobjectThe compensation activity of the activity

​
Sample response

{
  "data": {
    "results": [
      {
        "uid": "WORKFLOW001",
        "type": "WORKFLOW",
        "subType": "AI_AGENT",
        "uniqueIdentifier": "ticket-escalation-workflow",
        "name": "Ticket Escalation Workflow",
        "version": 1,
        "triggerEvent": {
          "id": "EVENT001",
          "name": "ticket.created",
          "description": "Triggered when a new ticket is created"
        },
        "filters": {
          "priority": "high",
          "team": "support"
        },
        "annotations": [
          {
            "entityType": "ticket",
            "data": {
              "autoEscalate": true
            },
            "relations": ["escalation"]
          }
        ],
        "workflowDefinition": [
          {
            "stepIdentifier": 1,
            "activity": {
              "name": "send-notification",
              "uniqueIdentifier": "notification.activity",
              "version": 1,
              "autoUpgradeToLatestVersion": true
            },
            "input": {
              "recipients": ["support-team"],
              "message": "High priority ticket requires immediate attention"
            },
            "retryPolicy": {
              "maximumAttempts": 3,
              "initialInterval": 1000,
              "backoffCoefficient": 2
            },
            "onFailure": "CONTINUE",
            "isSleepActivity": false,
            "executionTimeout": 30000,
            "dependencies": [],
            "filters": {}
          },
          {
            "stepIdentifier": 2,
            "activity": {
              "name": "assign-to-senior-agent",
              "uniqueIdentifier": "assignment.activity",
              "version": 1,
              "autoUpgradeToLatestVersion": true
            },
            "input": {
              "priority": "high",
              "skillSet": ["escalation", "technical"]
            },
            "retryPolicy": {
              "maximumAttempts": 2,
              "initialInterval": 5000,
              "backoffCoefficient": 1.5
            },
            "onFailure": "ABORT",
            "isSleepActivity": false,
            "executionTimeout": 60000,
            "dependencies": [1],
            "filters": {}
          }
        ],
        "executingAgent": "workflow-engine",
        "isActive": true,
        "createdAt": "2025-07-24T07:19:10.258Z",
        "updatedAt": "2025-07-24T07:19:10.258Z",
        "createdBy": "USER001",
        "teamId": "TEAM001",
        "metadata": {
          "description": "Automated workflow for escalating high-priority tickets",
          "tags": ["escalation", "automation", "support"]
        }
      }
    ],
    "total": 1
  },
  "status": true,
  "message": "Workflows retrieved successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}