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

# Workspaces

> The workspaces an agency key may act on, and which one this profile uses by default.

`reachboost workspaces` has 8 commands. Each one lists its arguments, its flags and what it is allowed to change.

Read-only

Changes data

Needs --yes

Needs --yes and --confirm-name

Built into the CLI

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

## workspaces get

Read-only

Get the workspace. Read-only. Returns the workspace the request is made for: its name, the number of sender licences it has, how many senders are in use, and how it is billed. Any key that may act on the workspace can read it, so a workspace key learns the name of its own workspace and an agency key learns the name of the linked workspace it is acting on.

```bash Usage theme={null}
reachboost workspaces get
```

## workspaces get-managed

Read-only

Get a managed workspace. Read-only. Returns one workspace the agency manages.

```bash Usage theme={null}
reachboost workspaces get-managed "<managed-workspace-uuid>"
```

**Arguments**

**\<managed-workspace-uuid>** `uuid` *required*

The unique identifier for the managed workspace.

## workspaces list

Read-only

List managed workspaces. Read-only. Returns a paginated list of all workspaces linked to the agency.

```bash Usage theme={null}
reachboost workspaces list
```

**Flags**

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

Filter by part of the workspace name, ignoring case.

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

Filter by billing type. Exact match. One of: `agency`, `stripe`.

**--owner \<uuid>** `uuid`

Filter by the UUID of the agency user who owns the workspace. Exact match.

**--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 workspaces list
```

## workspaces create-managed

Changes data

Create a managed workspace. Changes data. Creates a client workspace under the agency.

```bash Usage theme={null}
reachboost workspaces create-managed
```

**Flags**

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

Name of the workspace.

**--owner \<uuid>** `uuid`

UUID of the agency user who will own the workspace.

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

LinkedIn account licenses drawn from the agency's pool.

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

One of: `agency`, `stripe`.

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

## workspaces delete-managed

Needs --yes and --confirm-name

Delete a managed workspace. Irreversible: needs --yes and --confirm-name. Removes a managed workspace. This cannot be undone.

> [!CAUTION]
>
> Cannot be undone. Needs `--yes` and `--confirm-name`. See [Safety](https://docs.reachboost.io/cli/safety.md#--confirm-name).

```bash Usage theme={null}
reachboost workspaces delete-managed "<managed-workspace-uuid>"
```

**Arguments**

**\<managed-workspace-uuid>** `uuid` *required*

The unique identifier for the managed workspace.

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

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

The exact workspace name, repeated as a check that this is the right target. Cannot be undone.

## workspaces disconnect-managed

Needs --yes

Disconnect a managed workspace. Destructive: needs --yes. Unlinks a workspace from the agency. The workspace itself stays: its campaigns, leads and members are untouched, and its own people keep their access. What it loses is the agency's access to it.

> [!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 workspaces disconnect-managed "<managed-workspace-uuid>"
```

**Arguments**

**\<managed-workspace-uuid>** `uuid` *required*

The unique identifier for the managed workspace.

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

## workspaces update-managed

Changes data

Update a managed workspace. Changes data. Changes a managed workspace. Only the fields you send are changed. `PUT` is accepted as well and behaves identically.

```bash Usage theme={null}
reachboost workspaces update-managed "<managed-workspace-uuid>"
```

**Arguments**

**\<managed-workspace-uuid>** `uuid` *required*

The unique identifier for the managed workspace.

**Flags**

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

**--owner \<uuid>** `uuid`

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

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

One of: `agency`, `stripe`.

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

## workspaces use

Built into the CLI

Remember a workspace as the profile's default, so commands need no --workspace. The stored key must be allowed to use it.

```bash Usage theme={null}
reachboost workspaces use "<workspace-uuid>"
```

**Arguments**

**\<workspace-uuid>** `uuid` *required*

The workspace to act on by default.

```bash Example theme={null}
reachboost workspaces use "<workspace-uuid>"
```


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