GET /v1/tags/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Tags

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

# Get by ID
tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
print(f"{tag.fullyQualifiedName}: {tag.description}")

# Get by ID with fields
tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    fields=["owners", "children"]
)

# Get by fully qualified name
tag = Tags.retrieve_by_name("Certification.Bronze")

# Get by name with fields
tag = Tags.retrieve_by_name(
    "Certification.Bronze",
    fields=["owners", "children"]
)

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

// Get by ID
var tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f");

// Get by ID with fields
var tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    "owners,children"
);

// Get by fully qualified name
var tag = Tags.retrieveByName("Certification.Bronze");

// Get by name with fields
var tag = Tags.retrieveByName("Certification.Bronze", "owners,children");

# Get by ID
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/tags/name/Certification.Bronze?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
  "name": "Bronze",
  "fullyQualifiedName": "Certification.Bronze",
  "description": "Bronze certified Data Asset.",
  "style": {
    "color": "#C08320"
  },
  "version": 0.1,
  "updatedAt": 1769982619666,
  "updatedBy": "admin",
  "classification": {
    "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
    "type": "classification",
    "name": "Certification",
    "fullyQualifiedName": "Certification",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": false
}

GET

tags

{id}

GET /v1/tags/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Tags

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

# Get by ID
tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
print(f"{tag.fullyQualifiedName}: {tag.description}")

# Get by ID with fields
tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    fields=["owners", "children"]
)

# Get by fully qualified name
tag = Tags.retrieve_by_name("Certification.Bronze")

# Get by name with fields
tag = Tags.retrieve_by_name(
    "Certification.Bronze",
    fields=["owners", "children"]
)

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

// Get by ID
var tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f");

// Get by ID with fields
var tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    "owners,children"
);

// Get by fully qualified name
var tag = Tags.retrieveByName("Certification.Bronze");

// Get by name with fields
var tag = Tags.retrieveByName("Certification.Bronze", "owners,children");

# Get by ID
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/tags/name/Certification.Bronze?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
  "name": "Bronze",
  "fullyQualifiedName": "Certification.Bronze",
  "description": "Bronze certified Data Asset.",
  "style": {
    "color": "#C08320"
  },
  "version": 0.1,
  "updatedAt": 1769982619666,
  "updatedBy": "admin",
  "classification": {
    "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
    "type": "classification",
    "name": "Certification",
    "fullyQualifiedName": "Certification",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": false
}

Retrieve a Tag

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

Get by ID

string

required

UUID of the tag to retrieve.

fields

string

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

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

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

fqn

string

required

Fully qualified name of the tag (e.g., Certification.Bronze).

fields

string

Comma-separated list of fields to include: owners, children.

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/tags/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Tags

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

# Get by ID
tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
print(f"{tag.fullyQualifiedName}: {tag.description}")

# Get by ID with fields
tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    fields=["owners", "children"]
)

# Get by fully qualified name
tag = Tags.retrieve_by_name("Certification.Bronze")

# Get by name with fields
tag = Tags.retrieve_by_name(
    "Certification.Bronze",
    fields=["owners", "children"]
)

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

// Get by ID
var tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f");

// Get by ID with fields
var tag = Tags.retrieve(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    "owners,children"
);

// Get by fully qualified name
var tag = Tags.retrieveByName("Certification.Bronze");

// Get by name with fields
var tag = Tags.retrieveByName("Certification.Bronze", "owners,children");

# Get by ID
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/tags/name/Certification.Bronze?fields=owners,children" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
  "name": "Bronze",
  "fullyQualifiedName": "Certification.Bronze",
  "description": "Bronze certified Data Asset.",
  "style": {
    "color": "#C08320"
  },
  "version": 0.1,
  "updatedAt": 1769982619666,
  "updatedBy": "admin",
  "classification": {
    "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
    "type": "classification",
    "name": "Certification",
    "fullyQualifiedName": "Certification",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": false
}

Returns

Returns a tag object with all requested fields populated.

Response

string

Unique identifier for the tag (UUID format).

name

string

Tag name.

fullyQualifiedName

string

Fully qualified name of the tag.

displayName

string

Human-readable display name.

description

string

Description of the tag in Markdown format.

style

object

Visual styling for the tag.

classification

object

Reference to the parent classification.

provider

string

Provider: user or system.

owners

array

List of owners. Only included when fields contains owners.

children

array

Child tag references. Only included when fields contains children.

version

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 tag
`404`	`NOT_FOUND`	Tag with given ID or FQN does not exist

List Tags

Update a Tag

​Retrieve a Tag

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Tag

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling