GET /v1/glossaryTerms
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}")
import static org.openmetadata.sdk.fluent.GlossaryTerms.*;
// List first page
var result = GlossaryTerms.list()
.limit(50)
.execute();
for (var t : result.getData()) {
System.out.println(t.getFullyQualifiedName());
}
// Filter by glossary with fields
var result = GlossaryTerms.list()
.glossary("BusinessGlossary")
.fields("owners", "tags", "relatedTerms", "children")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/glossaryTerms?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by glossary
curl "{base_url}/api/v1/glossaryTerms?glossary=BusinessGlossary&fields=owners,tags,relatedTerms,children&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by parent term
curl "{base_url}/api/v1/glossaryTerms?parent=BusinessGlossary.Revenue&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
GET
/
v1
/
glossaryTerms
GET /v1/glossaryTerms
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}")
import static org.openmetadata.sdk.fluent.GlossaryTerms.*;
// List first page
var result = GlossaryTerms.list()
.limit(50)
.execute();
for (var t : result.getData()) {
System.out.println(t.getFullyQualifiedName());
}
// Filter by glossary with fields
var result = GlossaryTerms.list()
.glossary("BusinessGlossary")
.fields("owners", "tags", "relatedTerms", "children")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/glossaryTerms?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by glossary
curl "{base_url}/api/v1/glossaryTerms?glossary=BusinessGlossary&fields=owners,tags,relatedTerms,children&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by parent term
curl "{base_url}/api/v1/glossaryTerms?parent=BusinessGlossary.Revenue&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
string
Filter by glossary fully qualified name.
string
Filter by parent glossary term fully qualified name.
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include:
owners, tags, domains, relatedTerms, reviewers, children. See Supported Fields below.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/glossaryTerms
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}")
import static org.openmetadata.sdk.fluent.GlossaryTerms.*;
// List first page
var result = GlossaryTerms.list()
.limit(50)
.execute();
for (var t : result.getData()) {
System.out.println(t.getFullyQualifiedName());
}
// Filter by glossary with fields
var result = GlossaryTerms.list()
.glossary("BusinessGlossary")
.fields("owners", "tags", "relatedTerms", "children")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/glossaryTerms?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by glossary
curl "{base_url}/api/v1/glossaryTerms?glossary=BusinessGlossary&fields=owners,tags,relatedTerms,children&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by parent term
curl "{base_url}/api/v1/glossaryTerms?parent=BusinessGlossary.Revenue&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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 thefields parameter to request additional data.
Response
array
Array of glossary term objects.
Show properties
Show properties
string
Unique identifier for the glossary term (UUID format).
string
Glossary term name.
string
Fully qualified name of the glossary term.
array
List of synonym strings.
object
Reference to the parent glossary.
array
List of owners. Only included when
fields contains owners.array
Classification tags. Only included when
fields contains tags.array
Child term references. Only included when
fields contains children.array
Related term references. Only included when
fields contains relatedTerms.array
Reviewers. Only included when
fields contains reviewers.array
Domain assignments. Only included when
fields contains domains.object
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 |
Was this page helpful?
⌘I