# sz campaigns list

The `sz campaigns list` command is part of the [Scheduler Zero CLI](/cli). Reads one campaign page in a workspace. Requires an explicit workspace UUID or the single-workspace default saved at login. Supports search, status, limit and offset; there is no automatic pagination. Status values are all, draft, active, paused, archived and completed. limit and offset must be non-negative whole numbers in CLI parsing and are also validated by the API contract.

## Usage

```bash
sz campaigns list [options]
```

If you have not installed `sz` globally, replace `sz` in the usage above with `npx --yes @scheduler-zero/sz@latest` or `bunx @scheduler-zero/sz@latest`, preserving the arguments and options. See [installation](/cli/installation).

## Options

| Option | Meaning |
| --- | --- |
| `--api-key <key>` | API key (prefer SCHEDULER_ZERO_API_KEY) |
| `--base-url <url>` | API origin (default: https://api.schedulerzero.com) |
| `--workspace <id>` | Workspace id for workspace-scoped commands |
| `--search <text>` | Campaign search text |
| `--status <status>` | Campaign status filter |
| `--limit <n>` | Campaign page size |
| `--offset <n>` | Campaign offset |
| `--json` | Emit machine-readable JSON |
| `--format table\|json` | Select output format |
| `-h, --help` | Show this help |

## Examples

The UUIDs below are illustrative; use IDs from your own visible workspaces and campaigns.

```bash
sz campaigns list --workspace 11111111-1111-4111-8111-111111111111 --json
sz campaigns list --workspace 11111111-1111-4111-8111-111111111111 --status active --search Welcome --limit 25 --offset 0 --json
```

## Output and side effects

A paginated object with items and pagination metadata. Object responses remain JSON even with the default table format. Empty items is a successful result, not an authentication error. Advance offset deliberately to retrieve subsequent pages; concurrent changes can affect offset pagination.

## Authorization

Requires campaign:read in the named workspace, within the key's restrictions and the owner's live authority. Another workspace's permissions are not interchangeable.

## Underlying operations

- `campaigns.list`

Browser issuance stays a human-approved handoff where applicable; the command does not bypass that boundary. The exact product operation schemas are in [OpenAPI](/openapi.json) and [the REST Markdown reference](/rest-api/reference.md). For broader capabilities, use [MCP tools](/mcp/tools).

## Related documentation

[Get one campaign](/cli/commands/campaigns-get) · [Pagination recipe](/cli/scripting) · [REST schemas](/rest-api/reference)

[All CLI commands](/cli/commands) · [Troubleshooting](/cli/troubleshooting) · [This command as Markdown](/cli/commands/campaigns-list.md) · [CLI LLM index](/cli/llms.txt)