How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Teams API

A `Team` is a group of zero or more users and/or other teams. Teams can own zero or more data assets. Hierarchical teams are supported `Organization` -> `BusinessUnit` -> `Division` -> `Department`.

OpenMetadata Teams API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Team. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 27 operations across 22 paths, and defines 35 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

27 operations 22 paths 35 schemas 4 DELETE13 GET2 PATCH1 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Teams API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 27

Across 22 paths, the API surfaces 27 operations — 4 DELETE, 13 GET, 2 PATCH, 1 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Teams 27

A Team is a group of zero or more users and/or other teams. Teams can own zero or more data assets. Hierarchical teams are supported Organization - BusinessUnit - Division - Depar…

PUT
/v1/teams/{name}/assets/add
Bulk Add Assets
bulkAddAssets_2 1 param body → 200404
PUT
/v1/teams/{name}/assets/remove
Bulk Remove Assets
bulkRemoveAssets_2 1 param body → 200404
GET
/v1/teams
List teams
listTeams 7 params → 200
PUT
/v1/teams
Update team
createOrUpdateTeam body → 200400
POST
/v1/teams
Create a team
createTeam body → 200400
GET
/v1/teams/name/{name}
Get a team by name
getTeamByFQN 3 params → 200404
DELETE
/v1/teams/name/{name}
Delete a team by name
deleteTeamByName 2 params → 200404
GET
/v1/teams/{id}
Get a team by id
getTeamByID 4 params → 200404
DELETE
/v1/teams/{id}
Delete a team by id
deleteTeam 3 params → 200404
PATCH
/v1/teams/{id}
Update a team
patchTeam_1 1 param body → default
DELETE
/v1/teams/async/{id}
Asynchronously delete a team by id
deleteTeamAsync 3 params → 200404
DELETE
/v1/teams/{teamId}/users/{userId}
Remove a user from a team
deleteTeamUser 2 params → 200404
GET
/v1/teams/name/{name}/export
Export teams in CSV format
exportTeams 1 param → 200
GET
/v1/teams/name/{name}/exportAsync
Export teams in CSV format
exportTeams_1 1 param → 200
GET
/v1/teams/assets/counts
Get all teams with their asset counts
getAllTeamsWithAssetsCount → 200
GET
/v1/teams/documentation/csv
Get CSV documentation for team import/export
getCsvDocumentation_1 → default
GET
/v1/teams/{id}/versions/{version}
Get a version of the team
getSpecificTeamVersion 2 params → 200404
PUT
/v1/teams/name/{name}/import
Import from CSV to create, and update teams.
importTeams 2 params body → 200
PUT
/v1/teams/name/{name}/importAsync
Import from CSV to create, and update teams asynchronously.
importTeamsAsync 2 params body → 200
GET
/v1/teams/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_59 5 params → 200
GET
/v1/teams/hierarchy
List teams with hierarchy
listTeamsHierarchy 2 params → 200
GET
/v1/teams/{id}/assets
List assets owned by this team
listTeamAssets 3 params → 200404
GET
/v1/teams/name/{fqn}/assets
List assets owned by this team by fully qualified name
listTeamAssetsByName 3 params → 200404
GET
/v1/teams/{id}/versions
List team versions
listAllTeamVersion 1 param → 200
PATCH
/v1/teams/name/{fqn}
Update a team using name.
patchTeam 1 param body → default
PUT
/v1/teams/restore
Restore a soft deleted team
restore_46 body → 200
PUT
/v1/teams/{teamId}/users
Update team users
updateTeamUsers 1 param body → 200404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Team (45 properties), CreateTeam (21 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
BulkOperationResult
object
8 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
Profile
object
2 properties
RestoreEntity
object
1 property 1 required
CreateTeam
object
21 properties 2 required
Webhook
object
9 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
JsonPatch
object
Team
object
45 properties 2 required
ChangeDescription
object
5 properties
TeamList
object
5 properties 1 required
CSVExportResponse
object
2 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
BulkAssets
object
2 properties
Style
object
3 properties
Votes
object
4 properties
ImageList
object
7 properties
CsvImportResult
object
7 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
SubscriptionConfig
object
4 properties
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-teams-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Teams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.