Docs

zitadel events list

List events.

Usage

npx @zitadel/cli@latest events 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: category (equals; values request|auth|session|admin|entity|signal; repeats widen), event_type (equals; repeats widen), actor_id (equals), session_id (equals), flow_id (equals), request_id (equals), entity_type (equals), entity_id (equals), team_id (equals), created_at (greater_than_or_equal|less_than). Can be given more than once.
--sort <value>Sort as field:direction (asc|desc). Fields: occurred_at.
-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 events list --json
npx @zitadel/cli@latest events list --all --json
npx @zitadel/cli@latest events list --filter category=equals:<value> --sort occurred_at:desc

API

It calls List events, GET /events, in the Events API.

Was this helpful?