list_process_instances
Search and filter process instances by business key, definition key, or state. Retrieve both running and completed BPMN instances from CIB Seven with pagination support via the history API.
Instructions
Search for process instances using filters. Uses the history API to find both running and completed instances.
Use this when you need to find process instances by business key, definition key, or state. Returns an array of historic process instances.
Filter options:
processDefinitionKey: the BPMN process ID (e.g., "orderProcess")
businessKey: domain identifier (e.g., "ORDER-12345")
state: ACTIVE, COMPLETED, SUSPENDED, or EXTERNALLY_TERMINATED
maxResults: limit results (default 25)
firstResult: offset for pagination
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| processDefinitionKey | No | Filter by BPMN process definition key | |
| businessKey | No | Filter by business key | |
| active | No | Only active (running) instances | |
| suspended | No | Only suspended instances | |
| completed | No | Only completed instances | |
| maxResults | No | Max results to return (default 25) | |
| firstResult | No | Offset for pagination (default 0) |