Skip to main content

Synopsis

List flows for an org. By default, all flows for the org are returned. Pass —page-limit and/or —page to paginate the results; when pagination is requested the output includes pagination metadata and a page footer (table) or a “data”/“pagination” envelope (JSON). The list can be filtered by name with —name (and —ignore-case for case-insensitive matching).

Flags

FlagDescription
-h, --helphelp for flows
-i, --ignore-case[optional] Perform case-insensitive matching for --name. By default matching is case sensitive.
-N, --name string[optional] Only list flows whose name contains this substring. The Kosli API supports alphanumeric characters and ’-’.
-o, --output string[defaulted] The format of the output. Valid formats are: [table, json]. (default “table”)
--page int[defaulted] The page number of a response. (default 1)
-n, --page-limit int[defaulted] The number of elements per page. (default 20)

Flags inherited from parent commands

FlagDescription
-a, --api-token stringThe Kosli API token.
-c, --config-file string[optional] The Kosli config file path. (default “kosli”)
--debug[optional] Print debug logs to stdout.
-H, --host string[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
--http-proxy string[optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port
-r, --max-api-retries int[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--org stringThe Kosli organization.
-q, --quiet[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

Live Example

To view a live example of ‘kosli list flows’ you can run the command below (for the cyber-dojo demo organization).

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.
Last modified on July 14, 2026