---
title: "Teams"
slug: "teams-api"
status: "update"
updated: 2026-09-15T13:50:22Z
published: 2026-09-15T13:50:39Z
canonical: "developer.rocket.chat/teams-api"
---

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

# Teams

In Rocket.Chat, teams are a group of channels used to simplify communications. With the **Teams API**, you can:

- Create public and private teams.
- Manage team members by adding and removing them, and updating member information.
- Convert a team to a channel and add rooms to a team.

> [!NOTE]
> For details, refer to the [Teams user guide](https://docs.rocket.chat/docs/teams).

## The team object

Team endpoints return a team object. A trimmed example from [Get Team Info](https://developer.rocket.chat/apidocs/get-team-info):

```json
{
  "teamInfo": {
    "_id": "607e0d9b49d493189836bfac",
    "name": "Team1",
    "type": 1,
    "createdAt": "2021-04-19T23:09:15.106Z",
    "createdBy": { "_id": "FL2fZL4ERhwA3gWiS", "username": "some.username" },
    "roomId": "Dgh2xwJ3NFKWvKSqY"
  },
  "success": true
}
```

Fields you use most often:

- `_id`: The team ID. Pass it as `teamId` in requests; most team endpoints also accept `teamName`.
- `type`: `0` for a public team, `1` for a private team.
- `roomId`: The team's main channel. It is a regular room, so room and channel endpoints work on it.
- `createdBy`: The user who created the team.

## Common workflows

**Set up a team**

1. [Create the team](https://developer.rocket.chat/apidocs/create-a-new-team) with a name, type, and optional initial members.
2. [Add members](https://developer.rocket.chat/apidocs/add-members-to-the-team), and [update a member's roles](https://developer.rocket.chat/apidocs/update-team-member-info) to make them a team owner where needed.
3. [Add existing channels to the team](https://developer.rocket.chat/apidocs/add-rooms-to-a-team) to bring related conversations under it.

**Explore a team's rooms**

1. [List your teams](https://developer.rocket.chat/apidocs/get-list-of-teams) or [get a team's info](https://developer.rocket.chat/apidocs/get-team-info) to find its `teamId`.
2. [List the team's rooms](https://developer.rocket.chat/apidocs/list-rooms-of-a-team) or [its rooms and discussions](https://developer.rocket.chat/apidocs/list-rooms-and-discussions-of-a-team).
3. [Update a room in the team](https://developer.rocket.chat/apidocs/update-room-in-a-team), or [remove a room](https://developer.rocket.chat/apidocs/remove-room-from-the-team) to detach it.

**Wind a team down**

1. [Convert the team back to a channel](https://developer.rocket.chat/apidocs/convert-team-to-channel) if the extra structure is no longer needed.
2. [Delete the team](https://developer.rocket.chat/apidocs/delete-a-team), choosing which of its channels to delete with it.

## Conventions

- Most endpoints accept either `teamId` or `teamName`. Using `teamId` is safer because team names can change.
- A team is built on a main channel: the team object's `roomId` points to it, and team membership is separate from membership of individual channels in the team.
- Creating teams requires the `create-team` permission; managing members and rooms requires team owner rights or admin-level permissions. Each endpoint page lists its required permissions.
- List endpoints support `count`, `offset`, `sort`, and `query` [query parameters](https://developer.rocket.chat/apidocs/query-parameters).