GET /v1/glossaries/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

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

# Get by ID
glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3")
print(f"{glossary.fullyQualifiedName}: {glossary.description}")

# Get by ID with fields
glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    fields=["owners", "tags", "reviewers"]
)

# Get by fully qualified name
glossary = Glossaries.retrieve_by_name("BusinessGlossary")

# Get by name with fields
glossary = Glossaries.retrieve_by_name(
    "BusinessGlossary",
    fields=["owners", "tags", "reviewers"]
)

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

// Get by ID
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");

// Get by ID with fields
var glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "owners,tags,reviewers"
);

// Get by fully qualified name
var glossary = Glossaries.retrieveByName("BusinessGlossary");

// Get by name with fields
var glossary = Glossaries.retrieveByName("BusinessGlossary", "owners,tags,reviewers");

# Get by ID
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3?fields=owners,tags,reviewers" \
  -H "Authorization: Bearer {access_token}"

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

# Get by name with fields
curl "{base_url}/api/v1/glossaries/name/BusinessGlossary?fields=owners,tags,domains,reviewers" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "displayName": "Business Glossary",
  "description": "Standard business terminology for the organization",
  "version": 0.1,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": false
}

GET

glossaries

{id}

GET /v1/glossaries/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

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

# Get by ID
glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3")
print(f"{glossary.fullyQualifiedName}: {glossary.description}")

# Get by ID with fields
glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    fields=["owners", "tags", "reviewers"]
)

# Get by fully qualified name
glossary = Glossaries.retrieve_by_name("BusinessGlossary")

# Get by name with fields
glossary = Glossaries.retrieve_by_name(
    "BusinessGlossary",
    fields=["owners", "tags", "reviewers"]
)

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

// Get by ID
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");

// Get by ID with fields
var glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "owners,tags,reviewers"
);

// Get by fully qualified name
var glossary = Glossaries.retrieveByName("BusinessGlossary");

// Get by name with fields
var glossary = Glossaries.retrieveByName("BusinessGlossary", "owners,tags,reviewers");

# Get by ID
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3?fields=owners,tags,reviewers" \
  -H "Authorization: Bearer {access_token}"

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

# Get by name with fields
curl "{base_url}/api/v1/glossaries/name/BusinessGlossary?fields=owners,tags,domains,reviewers" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "displayName": "Business Glossary",
  "description": "Standard business terminology for the organization",
  "version": 0.1,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": false
}

Retrieve a Glossary

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

Get by ID

string

required

UUID of the glossary to retrieve.

string

Comma-separated list of fields to include (e.g., owners,tags,domains,reviewers).

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

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

string

required

Fully qualified name of the glossary (e.g., BusinessGlossary).

string

Comma-separated list of fields to include: owners, tags, domains, reviewers.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/glossaries/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

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

# Get by ID
glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3")
print(f"{glossary.fullyQualifiedName}: {glossary.description}")

# Get by ID with fields
glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    fields=["owners", "tags", "reviewers"]
)

# Get by fully qualified name
glossary = Glossaries.retrieve_by_name("BusinessGlossary")

# Get by name with fields
glossary = Glossaries.retrieve_by_name(
    "BusinessGlossary",
    fields=["owners", "tags", "reviewers"]
)

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

// Get by ID
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");

// Get by ID with fields
var glossary = Glossaries.retrieve(
    "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "owners,tags,reviewers"
);

// Get by fully qualified name
var glossary = Glossaries.retrieveByName("BusinessGlossary");

// Get by name with fields
var glossary = Glossaries.retrieveByName("BusinessGlossary", "owners,tags,reviewers");

# Get by ID
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3?fields=owners,tags,reviewers" \
  -H "Authorization: Bearer {access_token}"

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

# Get by name with fields
curl "{base_url}/api/v1/glossaries/name/BusinessGlossary?fields=owners,tags,domains,reviewers" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "displayName": "Business Glossary",
  "description": "Standard business terminology for the organization",
  "version": 0.1,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": false
}

Returns

Returns a glossary object with all requested fields populated.

Response

string

Unique identifier for the glossary (UUID format).

string

Glossary name.

string

Fully qualified name of the glossary.

string

Human-readable display name.

string

Description of the glossary in Markdown format.

boolean

Whether terms in this glossary are mutually exclusive.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

array

Reviewers. Only included when fields contains reviewers.

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 glossary
`404`	`NOT_FOUND`	Glossary 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 Glossary

Retrieve a Glossary

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling

​Retrieve a Glossary

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Glossary

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling