> ## 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.

# Lead lists

> Named sets of leads, imported or scraped, that campaigns draw from.

`reachboost lead-lists` has 9 commands. Each one lists its arguments, its flags and what it is allowed to change.

Read-only

Changes data

Needs --yes

Every command also accepts the [global flags](https://docs.reachboost.io/cli/commands.md#global-flags).

## lead-lists get

Read-only

Get lead list. Read-only. Retrieves a lead list by its UUID.

```bash Usage theme={null}
reachboost lead-lists get "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

## lead-lists leads

Read-only

Get leads in a lead list. Read-only. Returns all leads in a lead list by its UUID.

```bash Usage theme={null}
reachboost lead-lists leads "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--page \<n>** `number`

The page number.

**--per-page \<n>** `number`

The number of results per page.

**--all** `boolean`

Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with --page.

```bash Example theme={null}
reachboost lead-lists leads "<uuid>" --all --csv > leads.csv
```

## lead-lists list

Read-only

Get lead lists. Read-only. Returns all lead lists in your workspace. Supports filtering by name, type, and status.

```bash Usage theme={null}
reachboost lead-lists list
```

**Flags**

**--page \<n>** `number`

The page number.

**--per-page \<n>** `number`

The number of results per page.

**--name \<text>** `string`

Partial match filter (case-insensitive).

**--type \<value>** `enum`

Filter by list type. One of: `scrape`, `import`, `list`.

**--status \<value>** `enum`

Filter by status. One of: `draft`, `scraping`, `finished`, `failed`.

**--all** `boolean`

Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with --page.

```bash Example theme={null}
reachboost lead-lists list
```

## lead-lists add-lead

Changes data

Add lead to lead list. Changes data. Creates the lead if it doesn't exist (matched by `linkedin_profile_url`), then adds it to the lead list.

```bash Usage theme={null}
reachboost lead-lists add-lead "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--linkedin-profile-url \<text>** `string`

Must be a valid `https://www.linkedin.com/in/` URL. Various formats are auto-normalized.

**--first-name \<text>** `string`

**--last-name \<text>** `string`

**--company-name \<text>** `string`

**--job-role \<text>** `string`

**--profile-headline \<text>** `string`

**--connection-degree \<value>** `enum`

LinkedIn connection degree. One of: `1`, `2`, `3`.

**--email \<text>** `string`

Email must be a valid email address and unique within the workspace.

**--phone-number \<text>** `string`

Digits with an optional leading "+" and common separators (spaces, dashes, dots, parentheses); must contain 6–15 digits.

**--company-domain \<text>** `string`

**--company-linkedin-url \<text>** `string`

**--company-headcount \<n>** `number`

Must be a non-negative integer.

**--company-industry \<text>** `string`

**--city \<text>** `string`

**--country-code \<text>** `string`

ISO 3166-1 alpha-2 country code, stored upper-cased. Any other value is rejected.

**--custom-fields \<json>** `JSON`

As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## lead-lists bulk-add

Changes data

Add leads to a lead list in bulk. Changes data. Accepts up to 100 leads in one request and processes them in the background. All or nothing: if any lead fails validation, the whole batch is refused and nothing is queued.

```bash Usage theme={null}
reachboost lead-lists bulk-add "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--leads \<json>** `JSON`

The leads to add. Each item has the same shape and rules as `CreateLeadRequest`. As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

```bash Example theme={null}
reachboost lead-lists bulk-add "<uuid>" --body-file leads.json
```

## lead-lists create

Changes data

Create a lead list. Changes data.

```bash Usage theme={null}
reachboost lead-lists create
```

**Flags**

**--name \<text>** `string`

**--description \<text>** `string`

**--type \<value>** `enum`

One of: `scrape`, `import`, `list`.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## lead-lists delete

Needs --yes

Delete lead list. Destructive: needs --yes. Deletes a lead list by its UUID.

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost lead-lists delete "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## lead-lists remove-leads

Needs --yes

Remove leads from lead list. Destructive: needs --yes. Pass an array of entries identifying leads to remove. Each entry must include either `lead_uuid` or `linkedin_profile_url`.

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost lead-lists remove-leads "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--lead-uuid \<uuid>** `uuid[]`

One item per value; repeat the flag for several.

**--linkedin-profile-url \<text>** `string[]`

One item per value; repeat the flag for several.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## lead-lists update

Changes data

Update lead list. Changes data. Updates a lead list by its UUID.

```bash Usage theme={null}
reachboost lead-lists update "<lead-list-uuid>"
```

**Arguments**

**\<lead-list-uuid>** `uuid` *required*

The unique identifier for the lead list.

**Flags**

**--name \<text>** `string`

**--description \<text>** `string`

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.


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