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

# team-members

> List, read, invite, update and deactivate the agents in your workspace.

Team members are the agents and other users of the workspace. For fields and response details,
see the [API reference](/api-reference/team-members/list).

<Note>
  Sample output on this page is shown as the `--json` envelope, which is reproducible. Pretty
  tables depend on your terminal width. See [Output formats](/cli/output-formats).
</Note>

## team-members list

Lists the workspace's active team members. Narrow it to one person with `--email`, which matches
the address exactly.

```bash theme={"system"}
neetodesk team-members list --page-size 50
neetodesk team-members list --email oliver.smith@example.com
```

| Flag          | Type     | Required | Default | Description              |
| ------------- | -------- | -------- | ------- | ------------------------ |
| `--email`     | `string` |          |         | Filter by email          |
| `--page`      | `int`    |          | `0`     | Page number              |
| `--page-size` | `int`    |          | `0`     | Items per page (max 100) |

```json theme={"system"}
{
  "data": {
    "team_members": [
      {
        "id": "7b2c1d40-5e6f-4a81-9c23-0d4e5f6a7b8c",
        "email": "oliver.smith@example.com",
        "first_name": "Oliver",
        "last_name": "Smith",
        "time_zone": "Asia/Kolkata",
        "profile_image_url": null,
        "organization_role": "Admin",
        "active": true
      }
    ]
  },
  "pagination": {
    "total_records": 12,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 50
  }
}
```

## team-members show

Returns one team member's email address, name, time zone and role.

```bash theme={"system"}
neetodesk team-members show 7b2c1d40-5e6f-4a81-9c23-0d4e5f6a7b8c
```

### Required arguments

* `<id>` - the team member's UUID.

## team-members create

Invites one or more people to the workspace. Repeat `--email` to invite several at once. Each
address is emailed an invitation unless you pass `--send-invitation-email=false`.

```bash theme={"system"}
neetodesk team-members create \
  --email sam.smith@example.com \
  --email jane.doe@example.com \
  --role Agent
```

| Flag                      | Type          | Required | Default | Description                                          |
| ------------------------- | ------------- | -------- | ------- | ---------------------------------------------------- |
| `--email`                 | `stringArray` | Yes      | `[]`    | Email addresses to invite (repeat flag for multiple) |
| `--role`                  | `string`      | Yes      |         | Organization role (e.g. agent, admin)                |
| `--send-invitation-email` | `bool`        |          | `true`  | Send invitation email to new members                 |

<Note>
  `--role` must name a role that exists under **Roles** in your workspace settings.
</Note>

## team-members update

Changes a team member's email address, name, time zone or role. Pass only the flags you want to
change.

```bash theme={"system"}
neetodesk team-members update 7b2c1d40-5e6f-4a81-9c23-0d4e5f6a7b8c --role Admin
```

### Required arguments

* `<id>` - the team member's UUID.

| Flag           | Type     | Required | Default | Description       |
| -------------- | -------- | -------- | ------- | ----------------- |
| `--email`      | `string` |          |         | New email         |
| `--first-name` | `string` |          |         | First name        |
| `--last-name`  | `string` |          |         | Last name         |
| `--role`       | `string` |          |         | Organization role |
| `--time-zone`  | `string` |          |         | Time zone         |

## team-members delete

Deactivates a team member, ending their access to the workspace. Their user record is kept, so
the tickets and comments they handled stay attributed to them.

```bash theme={"system"}
neetodesk team-members delete 7b2c1d40-5e6f-4a81-9c23-0d4e5f6a7b8c
```

### Required arguments

* `<id>` - the team member's UUID.