GET /v1/teams
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]}")
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());
}
# 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}"
{
"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
}
}
List Teams
List all teams with optional filtering and pagination
GET
/
v1
/
teams
GET /v1/teams
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]}")
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());
}
# 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}"
{
"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
}
}
List Teams
List all teams with optional filtering and pagination.Query Parameters
string
Filter by parent team name to list only direct children of that team.
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include:
users, parents, children, policies, domains, owners. See Supported Fields below.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/teams
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]}")
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());
}
# 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}"
{
"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
}
}
Returns
Returns a paginated list of team objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
array
Array of team objects.
Show properties
Show properties
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).array
Parent team references. Only included when
fields contains parents.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.object
Supported Fields
The following fields can be requested via thefields 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 |
Was this page helpful?
⌘I