getProcessInstances
Retrieve a list of process instances from Camunda Engine, filterable by process definition, business key, and pagination.
Instructions
Get a list of process instances
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "getProcessInstances"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| processDefinitionId | No | Filter by the process definition the instances run on. | |
| processDefinitionKey | No | Filter by the key of the process definition the instances run on. | |
| businessKey | No | Filter by process instance business key. | |
| firstResult | No | Pagination of results. Specifies the index of the first result to return. | |
| maxResults | No | Pagination of results. Specifies the maximum number of results to return. |