Turfpal icon

Turfpal

Manage tasks, equipment, members, sites, observations, inventory, and more in Turfpal

Workflow → List Instances

AI-generated

Summary

List existing workflow instances with optional filters and pagination.

Inputs

  • Return All — Choose whether to return all workflow instances or limit the number of results.
  • Limit — Maximum number of workflow instances to return if 'Return All' is false; must be between 1 and 100.
  • Filters — Filter results by Template ID or Status (e.g. active, completed, cancelled).

Output shape

a list of workflow instance records

Supports pagination with 'Return All' and 'Limit' parameters. You can filter by workflow template ID and instance status to narrow results.

Examples

Example 1: List all instances of workflows without limitation

Set 'Return All' to true to fetch all workflow instances.

Example 2: List up to 50 active workflow instances of a specific template

Set 'Return All' to false, 'Limit' to 50, and filter by specific 'Template ID' and 'Status'='active'.

Links

Discussion