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

# List Teams

> List all teams with optional filtering and pagination

# List Teams

List all teams with optional filtering and pagination.

## Query Parameters

<ParamField query="parentTeam" type="string">
  Filter by parent team name to list only direct children of that team.
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `users`, `parents`, `children`, `policies`, `domains`, `owners`. See [Supported Fields](#supported-fields) below.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/teams theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import Teams

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # List first page
  teams = Teams.list(limit=50)
  for team in teams.data:
      print(f"{team.fullyQualifiedName} ({team.teamType})")

  # List all with auto-pagination
  for team in Teams.list_all():
      print(f"{team.fullyQualifiedName}")

  # Filter by parent team
  teams = Teams.list(
      parentTeam="Finance",
      fields=["users", "parents", "policies"],
      limit=50
  )

  for team in teams.data:
      print(f"{team.fullyQualifiedName}")
      if team.users:
          print(f"  Users: {[u.name for u in team.users]}")
      if team.parents:
          print(f"  Parents: {[p.name for p in team.parents]}")
  ```

  ```java GET /v1/teams theme={null}
  import static org.openmetadata.sdk.fluent.Teams.*;

  // List first page
  var result = Teams.list()
      .limit(50)
      .execute();

  for (var team : result.getData()) {
      System.out.println(team.getFullyQualifiedName());
  }

  // Filter by parent team with fields
  var result = Teams.list()
      .parentTeam("Finance")
      .fields("users", "parents", "policies")
      .limit(50)
      .execute();

  for (var team : result.getData()) {
      System.out.println(team.getFullyQualifiedName());
  }
  ```

  ```bash GET /v1/teams theme={null}
  # List all
  curl "{base_url}/api/v1/teams?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by parent team
  curl "{base_url}/api/v1/teams?parentTeam=Finance&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # With fields
  curl "{base_url}/api/v1/teams?parentTeam=Finance&fields=users,parents,policies,domains&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
        "teamType": "Group",
        "name": "Accounting",
        "fullyQualifiedName": "Accounting",
        "version": 0.1,
        "updatedAt": 1769982623753,
        "updatedBy": "admin",
        "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
        "parents": [
          {
            "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
            "type": "team",
            "name": "Finance",
            "fullyQualifiedName": "Finance",
            "displayName": "Finance",
            "deleted": false
          }
        ],
        "users": [
          {
            "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
            "type": "user",
            "name": "andrew_jennings3",
            "fullyQualifiedName": "andrew_jennings3",
            "displayName": "Andrew Jennings",
            "deleted": false
          }
        ],
        "deleted": false,
        "owners": [],
        "domains": [],
        "children": [],
        "policies": []
      }
    ],
    "paging": {
      "after": "...",
      "total": 25
    }
  }
  ```
</ResponseExample>

***

## Returns

Returns a paginated list of team objects. By default, only basic fields are included. Use the `fields` parameter to request additional data.

## Response

<ResponseField name="data" type="array">
  Array of team objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the team (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      Team name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name (same as name for teams).
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Human-readable display name.
    </ResponseField>

    <ResponseField name="teamType" type="string">
      Type of team (`Group`, `Department`, `Division`, `BusinessUnit`, `Organization`).
    </ResponseField>

    <ResponseField name="parents" type="array" optional>
      Parent team references. Only included when `fields` contains `parents`.
    </ResponseField>

    <ResponseField name="users" type="array" optional>
      Users belonging to this team. Only included when `fields` contains `users`.
    </ResponseField>

    <ResponseField name="children" type="array" optional>
      Child team references. Only included when `fields` contains `children`.
    </ResponseField>

    <ResponseField name="policies" type="array" optional>
      Policy references. Only included when `fields` contains `policies`.
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments. Only included when `fields` contains `domains`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of teams matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results. Null if this is the first page.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Supported Fields

The following fields can be requested via the `fields` query parameter:

| Field      | Description                            |
| ---------- | -------------------------------------- |
| `users`    | Users belonging to the team            |
| `parents`  | Parent team references                 |
| `children` | Child team references                  |
| `policies` | Policy references attached to the team |
| `domains`  | Domain assignments for governance      |
| `owners`   | Owner references (users and teams)     |

***

## Error Handling

| Code  | Error Type     | Description                             |
| ----- | -------------- | --------------------------------------- |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token |
| `403` | `FORBIDDEN`    | User lacks permission to list teams     |