Skip to main content

List all flows

Retrieve a paginated list of all flows created by the authenticated account. Each flow includes metadata about the template used, configured parameters, current execution state, and progress information.

Filtering & Sorting:

  • filter_by: Filter flows by state (e.g., 'running', 'completed', 'failed')
  • sort_by: Sort results by 'state', 'progress', 'created_at', 'started_at', or 'finished_at'

Response includes:

  • Flow ID and template information
  • Current state and progress percentage
  • Timestamps (created, started, finished)
  • Custom parameters and additional metadata
info

This endpoint allows you to list all flows.

Endpoint

GET https://flows.generio.ai/flows

Parameters

filter_by (optional)

Filter flows by their status to include only flows that have a certain status. Value must be one of: created, running, aborting, completed, aborted, and failed. If not provided, all flows are returned.

  • Location: query
  • Type: string

sort_by (optional)

Sort flows by one of: status, progress, created_at, started_at, finished_at

  • Location: query
  • Type: string
  • Default: created_at

Responses

200

Successful Response

422

Validation Error

Code Examples

Copy and run these examples in your terminal or code editor. Make sure to replace YOUR_TOKEN with your actual authentication token.

curl -X GET "https://flows.generio.ai/flows" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"