POST /v1/teams

from metadata.sdk import configure
from metadata.sdk.entities import Teams
from metadata.generated.schema.api.teams.createTeam import CreateTeamRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateTeamRequest(
    name="Accounting",
    teamType="Group",
    displayName="Accounting",
    description="Accounting team under Finance",
    parents=["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
)

team = Teams.create(request)
print(f"Created: {team.fullyQualifiedName.root}")

import java.util.List;
import java.util.UUID;
import org.openmetadata.schema.api.teams.CreateTeam;

// client is an initialized OpenMetadataClient.
var request = new CreateTeam()
    .withName("Accounting")
    .withTeamType(CreateTeam.TeamType.GROUP)
    .withDisplayName("Accounting")
    .withDescription("Accounting team under Finance")
    .withParents(List.of(UUID.fromString("4f87a3ea-d798-4509-8c64-5b11f8a96f89")));

var team = client.teams().create(request);

curl -X POST "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": [
      {
        "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
        "type": "team"
      }
    ]
  }'

{
  "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": [],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

POST

teams

POST /v1/teams

from metadata.sdk import configure
from metadata.sdk.entities import Teams
from metadata.generated.schema.api.teams.createTeam import CreateTeamRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateTeamRequest(
    name="Accounting",
    teamType="Group",
    displayName="Accounting",
    description="Accounting team under Finance",
    parents=["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
)

team = Teams.create(request)
print(f"Created: {team.fullyQualifiedName.root}")

import java.util.List;
import java.util.UUID;
import org.openmetadata.schema.api.teams.CreateTeam;

// client is an initialized OpenMetadataClient.
var request = new CreateTeam()
    .withName("Accounting")
    .withTeamType(CreateTeam.TeamType.GROUP)
    .withDisplayName("Accounting")
    .withDescription("Accounting team under Finance")
    .withParents(List.of(UUID.fromString("4f87a3ea-d798-4509-8c64-5b11f8a96f89")));

var team = client.teams().create(request);

curl -X POST "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": [
      {
        "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
        "type": "team"
      }
    ]
  }'

{
  "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": [],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

Create a Team

Create a new team for organizing users and controlling access to data assets.

Body Parameters

string

required

Name of the team. Must be unique across all teams.

string

required

Type of team. One of: Group, Department, Division, BusinessUnit, Organization.

string

Human-readable display name for the team.

string

Description of the team in Markdown format.

string

Email address associated with the team.

array

Array of parent team references. A team can belong to a parent team in the hierarchy.

Show properties

string

UUID of the parent team.

string

Type of entity (always team).

boolean

default:"true"

Whether users can join this team without an invitation.

array

Array of owner references (users or teams) to assign as owners of this team.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of policy references to attach to the team.

Show properties

string

UUID of the policy.

string

Type of entity (always policy).

array

Fully qualified names of the domains to assign for governance purposes.

POST /v1/teams

from metadata.sdk import configure
from metadata.sdk.entities import Teams
from metadata.generated.schema.api.teams.createTeam import CreateTeamRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateTeamRequest(
    name="Accounting",
    teamType="Group",
    displayName="Accounting",
    description="Accounting team under Finance",
    parents=["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
)

team = Teams.create(request)
print(f"Created: {team.fullyQualifiedName.root}")

import java.util.List;
import java.util.UUID;
import org.openmetadata.schema.api.teams.CreateTeam;

// client is an initialized OpenMetadataClient.
var request = new CreateTeam()
    .withName("Accounting")
    .withTeamType(CreateTeam.TeamType.GROUP)
    .withDisplayName("Accounting")
    .withDescription("Accounting team under Finance")
    .withParents(List.of(UUID.fromString("4f87a3ea-d798-4509-8c64-5b11f8a96f89")));

var team = client.teams().create(request);

curl -X POST "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": [
      {
        "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
        "type": "team"
      }
    ]
  }'

{
  "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": [],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

Returns

Returns the created team object with all specified properties and system-generated fields.

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.

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.

array

Child team references.

array

Policy references attached to the team.

array

List of owners assigned to the team.

array

Domain assignments for governance.

number

Version number for the entity (starts at 0.1).

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create teams
`409`	`ENTITY_ALREADY_EXISTS`	Team with same name already exists

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Create a Team

Create a Team

Body Parameters

Returns

Response

Error Handling