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

# Team

> 4 tools: heliyos_team_members_list, heliyos_team_members_invite, heliyos_team_members_remove, heliyos_team_members_change_role.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_team_members_list`](#heliyos-team-members-list) | List team members | Read |
| [`heliyos_team_members_invite`](#heliyos-team-members-invite) | Invite a team member | Write |
| [`heliyos_team_members_remove`](#heliyos-team-members-remove) | Remove a team member | Destructive |
| [`heliyos_team_members_change_role`](#heliyos-team-members-change-role) | Change a team member's role | Write |

Write and destructive tools change your workspace. Clients that support it ask before they run.

## List team members

`heliyos_team_members_list` · **Read** · Idempotent

Lists the workspace's people: joined members and pending invitations, each with its membership\_id, email, name, role (OWNER, ADMIN, MEMBER) and status (active, invited, declined or revoked). Filter by role or by text in the name or email. Returns structuredContent \{members:\[\{membership\_id, email, name, role, status}], total, next\_cursor}.

### Inputs

**role** `string`

Only members with this role. One of `OWNER`, `ADMIN`, `MEMBER`.

**search** `string`

Plain words matched against names and email addresses. Symbols such as + ( ) \[ ] \* ? can cause an error. Up to 200 characters.

**limit** `integer` (default: 20)

Members per page, 1 to 100. Default 20. From 1 to 100.

**cursor** `string`

next\_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.

**response\_format** `string` (default: concise)

"concise" (default) returns one row per person; "detailed" returns user ids and invitation dates too. One of `concise`, `detailed`.

### Returns

A readable text summary, plus `structuredContent` with `members`, `total`, `next_cursor`.

### API endpoints

* [List roles](https://docs.heliyos.ai/api-reference/team/list-roles.md) · `GET /v1/auth/roles`
* [List team members](https://docs.heliyos.ai/api-reference/team/list-team-members.md) · `GET /v1/auth/team-memberships`

## Invite a team member

`heliyos_team_members_invite` · **Write**

Emails an invitation to join the workspace with the given role (ADMIN or MEMBER). A second invite to an email with a pending invitation fails with CONFLICT (resend it from Heliyos), so check heliyos\_team\_members\_list first. Returns structuredContent \{member} with the new membership\_id and status invited.

### Inputs

**email** `string` *required*

The person's email address. Up to 320 characters.

**role** `string` *required*

ADMIN or MEMBER. OWNER cannot be granted with an API key; an owner does that in Heliyos Settings, Team. One of `OWNER`, `ADMIN`, `MEMBER`.

### Returns

A readable text summary, plus `structuredContent` with `member`.

### API endpoints

* [List roles](https://docs.heliyos.ai/api-reference/team/list-roles.md) · `GET /v1/auth/roles`
* [Invite a team member](https://docs.heliyos.ai/api-reference/team/invite-a-team-member.md) · `POST /v1/auth/team-memberships`

## Remove a team member

`heliyos_team_members_remove` · **Destructive** · Idempotent

Removes a person from the workspace, or cancels a pending invitation, by membership\_id (from heliyos\_team\_members\_list). They lose access immediately. This cannot be undone (they would need a new invitation): confirm with the user first. The last owner cannot be removed. Returns structuredContent \{membership\_id, removed}.

### Inputs

**membership\_id** `string` *required*

membership\_id: a 24-character hex id. A 24-character hex id.

### Returns

A readable text summary, plus `structuredContent` with `membership_id`, `removed`.

### API endpoints

* [List roles](https://docs.heliyos.ai/api-reference/team/list-roles.md) · `GET /v1/auth/roles`
* [Remove a team member](https://docs.heliyos.ai/api-reference/team/remove-a-team-member.md) · `DELETE /v1/auth/team-memberships/{id}`

## Change a team member's role

`heliyos_team_members_change_role` · **Write** · Idempotent

Sets a team member's role to ADMIN or MEMBER by membership\_id (from heliyos\_team\_members\_list). Owners' roles and the OWNER role cannot be changed with an API key. Returns structuredContent \{membership\_id, role}.

### Inputs

**membership\_id** `string` *required*

membership\_id: a 24-character hex id. A 24-character hex id.

**role** `string` *required*

ADMIN or MEMBER. OWNER cannot be granted with an API key; an owner does that in Heliyos Settings, Team. One of `OWNER`, `ADMIN`, `MEMBER`.

### Returns

A readable text summary, plus `structuredContent` with `membership_id`, `role`.

### API endpoints

* [List roles](https://docs.heliyos.ai/api-reference/team/list-roles.md) · `GET /v1/auth/roles`
* [Change a team member role](https://docs.heliyos.ai/api-reference/team/change-a-team-member-role.md) · `PATCH /v1/auth/team-memberships/{id}/role`


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