GET /v1/teams/{id}

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"
)

# Get by ID
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
print(f"{team.fullyQualifiedName}: {team.teamType}")

# Get by ID with fields
team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    fields=["users", "parents", "policies"]
)

# Get by fully qualified name
team = Teams.retrieve_by_name("Accounting")

# Get by name with fields
team = Teams.retrieve_by_name(
    "Accounting",
    fields=["users", "parents", "children"]
)

import static org.openmetadata.sdk.fluent.Teams.*;

// Get by ID
var team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a");

// Get by ID with fields
var team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    "users,parents,policies"
);

// Get by fully qualified name
var team = Teams.retrieveByName("Accounting");

// Get by name with fields
var team = Teams.retrieveByName(
    "Accounting",
    "users,parents,children"
);

# Get by ID
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a?fields=users,parents,policies" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/teams/name/Accounting" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/teams/name/Accounting?fields=users,parents,children" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

teams

{id}

GET /v1/teams/{id}

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"
)

# Get by ID
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
print(f"{team.fullyQualifiedName}: {team.teamType}")

# Get by ID with fields
team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    fields=["users", "parents", "policies"]
)

# Get by fully qualified name
team = Teams.retrieve_by_name("Accounting")

# Get by name with fields
team = Teams.retrieve_by_name(
    "Accounting",
    fields=["users", "parents", "children"]
)

import static org.openmetadata.sdk.fluent.Teams.*;

// Get by ID
var team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a");

// Get by ID with fields
var team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    "users,parents,policies"
);

// Get by fully qualified name
var team = Teams.retrieveByName("Accounting");

// Get by name with fields
var team = Teams.retrieveByName(
    "Accounting",
    "users,parents,children"
);

# Get by ID
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a?fields=users,parents,policies" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/teams/name/Accounting" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/teams/name/Accounting?fields=users,parents,children" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Retrieve a Team

Get a single team by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the team to retrieve.

string

Comma-separated list of fields to include (e.g., users,parents,children,policies,domains,owners).

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/teams/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the team (e.g., Accounting).

string

Comma-separated list of fields to include: users, parents, children, policies, domains, owners.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/teams/{id}

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"
)

# Get by ID
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
print(f"{team.fullyQualifiedName}: {team.teamType}")

# Get by ID with fields
team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    fields=["users", "parents", "policies"]
)

# Get by fully qualified name
team = Teams.retrieve_by_name("Accounting")

# Get by name with fields
team = Teams.retrieve_by_name(
    "Accounting",
    fields=["users", "parents", "children"]
)

import static org.openmetadata.sdk.fluent.Teams.*;

// Get by ID
var team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a");

// Get by ID with fields
var team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    "users,parents,policies"
);

// Get by fully qualified name
var team = Teams.retrieveByName("Accounting");

// Get by name with fields
var team = Teams.retrieveByName(
    "Accounting",
    "users,parents,children"
);

# Get by ID
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a?fields=users,parents,policies" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/teams/name/Accounting" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/teams/name/Accounting?fields=users,parents,children" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Returns

Returns a team object with all requested fields populated.

Response

string

Unique identifier for the team (UUID format).

string

Team name.

string

Fully qualified name (same as name for teams).

string

Human-readable display name.

string

Type of team (Group, Department, Division, BusinessUnit, Organization).

string

Description of the team in Markdown format.

array

Parent team references. Only included when fields contains parents.

Show properties

string

UUID of the parent team.

string

Type of entity (always team).

string

Name of the parent team.

string

Fully qualified name of the parent team.

array

Users belonging to this team. Only included when fields contains users.

array

Child team references. Only included when fields contains children.

array

Policy references. Only included when fields contains policies.

array

List of owners. Only included when fields contains owners.

array

Domain assignments. Only included when fields contains domains.

number

Version number for the entity.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this team
`404`	`NOT_FOUND`	Team with given ID or FQN does not exist

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Retrieve a Team

Retrieve a Team

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling

​Retrieve a Team

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Team

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling