List Glossary Terms

List all glossary terms with optional filtering and pagination

GET /v1/glossaryTerms

GET /v1/glossaryTerms

Python

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# List first page
terms = GlossaryTerms.list(limit=50)
for t in terms.data:
    print(f"{t.fullyQualifiedName}")

# List all with auto-pagination
for t in GlossaryTerms.list_all():
    print(f"{t.fullyQualifiedName}")

# Filter by glossary with fields
terms = GlossaryTerms.list(
    glossary="BusinessGlossary",
    fields=["owners", "tags", "relatedTerms", "children"],
    limit=50
)

for t in terms.data:
    print(f"{t.fullyQualifiedName}")
    if t.synonyms:
        print(f"  Synonyms: {t.synonyms}")

Response

{
  "data": [
    {
      "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
      "name": "Revenue",
      "fullyQualifiedName": "BusinessGlossary.Revenue",
      "displayName": "Revenue",
      "description": "Total income generated from business operations",
      "synonyms": ["Income", "Earnings", "Sales"],
      "glossary": {
        "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
        "type": "glossary",
        "name": "BusinessGlossary",
        "fullyQualifiedName": "BusinessGlossary",
        "deleted": false
      },
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
      "deleted": false,
      "owners": [],
      "tags": [],
      "children": [],
      "relatedTerms": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 15
  }
}

List Glossary Terms

List all glossary terms with optional filtering and pagination.

Query Parameters

glossary · string

Filter by glossary fully qualified name.

parent · string

Filter by parent glossary term fully qualified name.

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

Comma-separated list of fields to include: owners, tags, domains, relatedTerms, reviewers, children. See Supported Fields below.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/glossaryTerms

Python

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# List first page
terms = GlossaryTerms.list(limit=50)
for t in terms.data:
    print(f"{t.fullyQualifiedName}")

# List all with auto-pagination
for t in GlossaryTerms.list_all():
    print(f"{t.fullyQualifiedName}")

# Filter by glossary with fields
terms = GlossaryTerms.list(
    glossary="BusinessGlossary",
    fields=["owners", "tags", "relatedTerms", "children"],
    limit=50
)

for t in terms.data:
    print(f"{t.fullyQualifiedName}")
    if t.synonyms:
        print(f"  Synonyms: {t.synonyms}")

Response

{
  "data": [
    {
      "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
      "name": "Revenue",
      "fullyQualifiedName": "BusinessGlossary.Revenue",
      "displayName": "Revenue",
      "description": "Total income generated from business operations",
      "synonyms": ["Income", "Earnings", "Sales"],
      "glossary": {
        "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
        "type": "glossary",
        "name": "BusinessGlossary",
        "fullyQualifiedName": "BusinessGlossary",
        "deleted": false
      },
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
      "deleted": false,
      "owners": [],
      "tags": [],
      "children": [],
      "relatedTerms": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 15
  }
}

---

Returns

Returns a paginated list of glossary term objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of glossary term objects.

Show properties

id · string

Unique identifier for the glossary term (UUID format).

name · string

Glossary term name.

fullyQualifiedName · string

Fully qualified name of the glossary term.

synonyms · array

List of synonym strings.

glossary · object

Reference to the parent glossary.

owners · array

List of owners. Only included when fields contains owners.

tags · array

Classification tags. Only included when fields contains tags.

children · array

Child term references. Only included when fields contains children.

relatedTerms · array

Related term references. Only included when fields contains relatedTerms.

reviewers · array

Reviewers. Only included when fields contains reviewers.

domains · array

Domain assignments. Only included when fields contains domains.

paging · object

Pagination information.

Show properties

total · integer

Total count of glossary terms matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.

---

Supported Fields

Field	Description
owners	Owner references (users and teams)
tags	Classification tags
domains	Domain assignments for governance
relatedTerms	Related glossary term references
reviewers	Glossary term reviewers
children	Child glossary term references

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list glossary terms