List of Flows

Definition

The "List of Flows" action retrieves a comprehensive list of all flows within the current workspace in Zenphi. This action provides detailed metadata about each flow, including its ID, name, description, version, publication status, creator and publisher information, and timestamps related to creation and updates. With pagination support through page size and page token inputs, it efficiently handles large workspaces with many flows. This action is essential for managing, auditing, or referencing flows programmatically within your automation processes, enabling you to easily fetch and work with flow information dynamically.

Key capabilities include:

  • Fetching detailed metadata for multiple flows in a workspace.
  • Pagination support to handle large datasets.
  • Insights into flow status such as published/draft and version history.
  • Access to user information related to flow creation and publishing.


Example Use Cases


1. Flow Inventory Management

Easily retrieve and maintain an up-to-date list of all flows in your workspace to keep track of active and draft automations.

2. Flow Version Tracking

Get detailed information about flow versions and their last published time to monitor updates and changes over time.

3. Automated Flow Auditing

Use flow metadata such as creator and publisher details to generate reports for compliance and auditing purposes.

4. Dynamic Flow Selection

Fetch flows dynamically in your automation to enable conditional processing based on flow names, statuses, or other metadata.

5. Integration with Query Collection

Combine with query actions to search and filter flows by specific attributes (like name or status) for more targeted automation logic.



Inputs

1. Page Size

Defines the maximum number of flow records to return in a single request. This number must be between 1 and 500. Setting a reasonable page size helps manage the volume of data retrieved and optimize performance.Example: If you set the page size to 100, the action will return up to 100 flows per call. If your workspace has 250 flows, you’ll receive the first 100 in the initial response, then you can request subsequent pages.


2. Page Token

This token is used to fetch the next set of results when the total number of flows exceeds the specified page size. If this field is left empty or not specified, the action will return the first page of flows. After the initial response, use the returned "next page token" value here to continue retrieving additional flows.Example: When you receive a next page token from a previous run, provide it here to get the next batch of flow records, ensuring you can iterate through all available flows in your workspace.



Outputs


1. Next Page Token

A token string used to retrieve the next page of flow records if there are more flows than the current page size allows. If this value is empty, it means there are no more records to fetch. Use this token in the next request’s Page Token input to continue paginating through the list of flows.Use case: Enables efficient handling of large workspaces by fetching flows in manageable chunks instead of all at once.


2. Flows (List of Flows)

A collection of flow objects within the current workspace, where each flow contains the following detailed fields:

  • IdThe unique identifier of the flow, used to reference the flow programmatically in other actions or APIs. Example: flow_12345

  • NameThe name assigned to the flow, making it easily recognizable to users. Example: Invoice Approval Process

  • DescriptionA brief summary or explanation of what the flow does, helping users understand its purpose without opening the flow editor. Example: Automates the approval workflow for incoming invoices.

  • VersionThe current version number of the flow, useful for tracking changes and updates over time. Example: 3

  • Is Flow PublishedA boolean flag indicating whether the flow is published (active) or unpublished (draft). Example: true means the flow is live and usable; false means it’s still in draft mode.

  • Publisher NameThe full name of the user who last published the flow. Example: Jane Doe

  • Publisher EmailThe email address of the flow’s last publisher, useful for auditing or communication purposes. Example: [email protected]

  • Last Published TimeThe timestamp indicating when the flow was last published, providing insight into the flow’s recency and maintenance. Example: 2025-07-21T10:15:00Z

  • Created By NameThe full name of the user who originally created the flow. Example: John Smith

  • Created By EmailThe email address of the creator of the flow. Example: [email protected]

  • Created TimeThe date and time when the flow was initially created, useful for tracking flow lifecycle. Example: 2024-03-15T09:00:00Z

  • Last Updated By NameThe full name of the user who last updated the flow, showing who made the latest changes. Example: Emily Johnson

  • Last Updated By EmailThe email address of the person who last updated the flow. Example: [email protected]

  • Last Updated TimeThe timestamp of the most recent update to the flow, helping to assess its freshness. Example: 2025-07-20T16:30:00Z

  • DraftIndicates whether the flow currently has a draft version that is not yet published. This helps identify flows under active development. Example: true means there is an unpublished draft; false means no draft exists.


This detailed output helps customers not only retrieve a list of flows but also get a full context about each flow’s status, ownership, and update history — essential for management and auditing within Zenphi.


Example Scenario: Managing Active Workflows in Your Workspace

Imagine you are an automation manager overseeing multiple workflows in your organization’s Zenphi workspace. You want to create a report or dashboard that shows all active flows, including their names, versions, and who last published them. This helps you track which flows are live, who owns them, and when they were last updated.

How to set it up:

  1. Use the “List of Flows” action to retrieve all flows in your current workspace.
  2. Specify the Page Size to limit the number of flows returned at once (e.g., 100).
  3. If your workspace has more than 100 flows, use the Next Page Token output to paginate and get additional flows.
  4. Once you have the list, use other actions like “Query Collection” or “Filter Array” to find flows by name, status, or publisher.
  5. Generate reports, send notifications, or display flow details on a dashboard based on this data.

This setup helps you automate the monitoring and management of your flows, saving time and ensuring you always have up-to-date information on your automation processes.