> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reachboost.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> One command per documented API call, for a terminal or a scheduler. Tables to read, JSON and CSV to script, and safety flags on everything that changes data.

john\@reachboost: reachboost

Skip

<pre />

Read commands print a table by default; `--json` and `--csv` are one flag away. The campaign names are examples.

## What you can do

> [card] Read anything the API documents
>
> Campaigns, leads, lead lists, senders, tags, the inbox and statistics, one page or every page at once.

> [card] Change data, with a net
>
> Tags and lead lists can be created, changed and deleted; leads can be created and changed; senders can be changed and deleted. Campaigns can be created and edited while they are drafts, and a draft can be published. Every write has `--dry-run`; every delete needs `--yes`.

> [card] Script it
>
> JSON exactly as the API returns it (with `--all`, every page joined into one document), CSV for spreadsheets, fixed exit codes, and a key from the environment for CI.

> [!NOTE]
>
> The CLI uses an API key. A key has full access to its workspace, so the CLI keeps it in the macOS Keychain or the Linux secret service where it can, otherwise in a file only you can read, and never takes it as a command line argument.

## Requirements

* Node.js 20 or newer, on macOS, Linux or Windows.
* An API key, created in ReachBoost under [Integrations > API keys](https://app.reachboost.io/integrations/api). A key belongs to one workspace.
* The workspace uuid, shown on the same page as the key.

## Next steps

> [card] [Quickstart](https://docs.reachboost.io/cli/quickstart.md)
>
> Install the CLI, store an API key once, and run your first command. About five minutes.

> [card] [All commands](https://docs.reachboost.io/cli/commands.md)
>
> Every command the CLI has, grouped the way you type them, with arguments, flags and what each one is allowed to change.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.