Skip to navigation

List available workflow builder workflows

View as Markdown

This operation retrieves a list of all available Workflow Builder workflows. It returns basic information about each workflow, including its unique identifier (id), name, description, and the input schema required to trigger the workflow.

The response provides key details that help users identify which workflows are available and understand the input requirements for triggering each one. Each workflow entry also includes metadata, such as when it was created, last modified, and by whom.

This operation is useful for obtaining an overview of all workflows within the system, helping users and systems know what workflows are defined, what inputs they require, and how they can be triggered.

Use Cases:

  • Listing all available workflows in a system for manual or automated workflow initiation.
  • Reviewing the input requirements for a workflow before triggering it programmatically.
  • Gathering basic metadata about workflows for auditing, logging, or reporting purposes.

Key Features:

  • Comprehensive Workflow Overview: Provides a full list of workflows, giving visibility into all the automated processes available within the Workflow Builder platform.
  • Input Schema Information: Each workflow includes its trigger input schema, showing what data must be provided when triggering the workflow.
  • Metadata for Tracking: Useful metadata like creation time, last modification date, and user details are included to support tracking and auditing workflows.
  • Future-Proof: The operation is designed to be expandable as more workflows are added or the platform grows, ensuring scalability in the workflow management process.

Authentication

AuthorizationBearer

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"
The unique identifier of the account.

Response

A list of workflows has been successfully returned.
datalist of objectsOptional
A list of workflows
response_metadataobjectOptional

Additional server-side metadata for a given response

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error