zitadel users list
List users.
Usage
npx @zitadel/cli@latest users list [flags]Flags
| Flag | Description |
|---|---|
--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, --all | Fetch 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. |
--plain | Tab-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: created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal), id (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal), schema (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal), schema_object_type (equals|not_equals|contains), status (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal), lifecycle_owner_team_id (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal). Can be given more than once. |
--sort <value> | Sort as field:direction (asc|desc). Fields: created_at, id, schema, status, lifecycle_owner_team_id. |
-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 users list --json
npx @zitadel/cli@latest users list --all --json
npx @zitadel/cli@latest users list --filter created_at=equals:<value> --sort created_at:descAPI
It calls Query users, POST /users/query, in the Users API.
Was this helpful?