Skip to content
CLIUnofficial

privy users list

List or search user summaries; --full retains complete user records. Cursor-paginated.

Usage

Section titled “Usage”
Terminal window
privy users list [options]

Options

Section titled “Options”
Option Description
--dry-run Validate and print the API request without network access or credentials.
--limit <integer> Items per API page (1–100; default 20).
--cursor <string> Opaque next_cursor from a previous response.
--query <string> Search term as supported by this dashboard resource.
--account-type <string> Filter by linked account type supported by the dashboard.
--all Follow cursors with this command’s page size, bounded by --max-pages.
--max-pages <number> Maximum pages with --all (1–100; default 10).
--full Return full existing row detail instead of summaries; independent of --all; redaction still applies.

Global options such as --app, --account and --profile also apply. See the command reference overview.

Examples

Section titled “Examples”
Terminal window
privy users list --limit 20
privy users list --query user@example.com
privy users list --all --max-pages 5
privy users list --all --full --max-pages 5

Behavior

Section titled “Behavior”
  • Changes data: no, read-only.
  • Scope: app
Section titled “Related guides”

Inspect the full contract locally with privy schema users list.

Privy CLI is an unofficial, community project by Samarth Saxena. Not affiliated with or endorsed by Privy. The Privy name and wordmark belong to Privy. It uses undocumented dashboard APIs that can change.