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

# Teams

> Create and manage teams for organizing users and controlling access

# Teams

A **Team** is an organizational unit used to group users and control access to data assets. Teams support a hierarchical structure that mirrors your organization.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/teams-users/team/).
</Info>

## Entity Hierarchy

Teams can be nested in a strict hierarchy:

<CodeGroup>
  ```txt Team Hierarchy theme={null}
  Organization
  └── BusinessUnit
      └── Division
          └── Department
              └── Group (this is the most common team type)
  ```
</CodeGroup>

## Team Types

| Type           | Description                                                               |
| -------------- | ------------------------------------------------------------------------- |
| `Organization` | Top-level entity representing the entire organization                     |
| `BusinessUnit` | A major business unit within the organization                             |
| `Division`     | A division within a business unit                                         |
| `Department`   | A department within a division                                            |
| `Group`        | The most granular team type, typically used for day-to-day access control |

## Fully Qualified Name

The FQN format for a team is simply:

```
teamName
```

For example: `Accounting`

***

## API Endpoints

| Method   | Endpoint                            | Description                                                                      |
| -------- | ----------------------------------- | -------------------------------------------------------------------------------- |
| `POST`   | `/v1/teams`                         | [Create a team](/v1.12.x/api-reference/teams-and-users/teams/create)             |
| `GET`    | `/v1/teams`                         | [List teams](/v1.12.x/api-reference/teams-and-users/teams/list)                  |
| `GET`    | `/v1/teams/{id}`                    | [Get by ID](/v1.12.x/api-reference/teams-and-users/teams/retrieve)               |
| `GET`    | `/v1/teams/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/teams-and-users/teams/retrieve)              |
| `PATCH`  | `/v1/teams/{id}`                    | [Update by ID](/v1.12.x/api-reference/teams-and-users/teams/update)              |
| `DELETE` | `/v1/teams/{id}`                    | [Delete by ID](/v1.12.x/api-reference/teams-and-users/teams/delete)              |
| `PUT`    | `/v1/teams/restore`                 | [Restore soft-deleted team](/v1.12.x/api-reference/teams-and-users/teams/delete) |
| `GET`    | `/v1/teams/{id}/versions`           | [List versions](/v1.12.x/api-reference/teams-and-users/teams/versions)           |
| `GET`    | `/v1/teams/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/teams-and-users/teams/versions)    |
