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

# Invitations

> Invitations to join the workspace. Creating one sends the invitation mail and prints the link; withdrawing one stops the link working.

`reachboost invitations` has 4 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).

## invitations get

Read-only

Get an invitation. Read-only.

```bash Usage theme={null}
reachboost invitations get "<invitation-uuid>"
```

**Arguments**

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

The unique identifier for the invitation. This is not the invitation token.

## invitations list

Read-only

List invitations. Read-only. Pending and expired invitations, newest first. Accepted invitations (the person has joined) and withdrawn invitations are never listed. `status` is computed: an invitation past its `expires_at` is `expired` even though nothing rewrote its stored status, and the filter follows the same rule. Filters combine with AND across fields; `role` and `status` take several comma-separated values and match any of them.

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

**Flags**

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

The page number.

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

The number of results per page.

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

Partial match filter on the first name (case-insensitive).

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

Partial match filter on the last name (case-insensitive).

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

Partial match filter on the email address (case-insensitive).

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

Exact match on the role, one or more of `workspace_member`, `workspace_admin`, `agency_member`, `agency_admin` separated by commas.

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

Exact match on the computed status, one or more of `pending`, `expired`, `accepted` separated by commas. `accepted` never matches because accepted invitations are not listed.

**--all** `boolean`

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

## invitations create

Changes data

Invite someone to the workspace. Changes data. Creates the invitation and sends the invitation mail the same way the settings page does. `role` defaults to the member role of the workspace type (`workspace_member`, or `agency_member` on an agency workspace) and must be one of that type's two roles. Because an API key has no user behind it, `invited_by` is the workspace's first admin. The response carries `invitation_url`, which can be handed to the person directly; it is returned whether or not a mail went out (white-label workspaces send none).

```bash Usage theme={null}
reachboost invitations create
```

**Flags**

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

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

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

**--role \<value>** `enum` (default: the member role of the workspace type)

Defaults to the member role of the workspace type. Must be one of that type's two roles. One of: `workspace_member`, `workspace_admin`, `agency_member`, `agency_admin`.

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

## invitations delete

Needs --yes

Withdraw an invitation. Destructive: needs --yes. The invitation stops being listed and its link stops working. Accepted invitations cannot be withdrawn and answer 404.

> [!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 invitations delete "<invitation-uuid>"
```

**Arguments**

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

The unique identifier for the invitation. This is not the invitation token.

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


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