Docs

zitadel flow-definitions list

List flow-definitions.

Usage

npx @zitadel/cli@latest flow-definitions list [flags]

Flags

FlagDescription
--limit <value>Page size (server default 20, max 100). From 1 to 100.
--page-token <value>Continue from a previous page's next_page_token.
-a, --allFetch every page instead of one. Not with --page-token.
--fields <value>Columns to show, comma-separated dot-paths (e.g. id,attributes.email). Defaults to the resource's own columns; --json is unaffected.
--plainTab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--filter <value>Filter as field=operation:value (operation defaults to equals). Fields: name (equals), purpose (equals), revisions (equals; values all|latest). Can be given more than once.
-e, --env <value>Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then development.
--env-file <value>Read ZITADEL_* values from this file ahead of the process environment. A relative path is read from the current directory, not from --cwd. Cannot be combined with --env.

It also takes the global flags.

Examples

npx @zitadel/cli@latest flow-definitions list --json
npx @zitadel/cli@latest flow-definitions list --all --json
npx @zitadel/cli@latest flow-definitions list --filter name=equals:<value>

API

It calls List flow definitions, GET /flow_definitions, in the Flow definitions API.

Was this helpful?