Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
glossaryTerms
GET /v1/glossaryTerms
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.getcollate.io/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}")
{
  "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
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.getcollate.io/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}")
{
  "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.
paging
object
Pagination information.

Supported Fields

FieldDescription
ownersOwner references (users and teams)
tagsClassification tags
domainsDomain assignments for governance
relatedTermsRelated glossary term references
reviewersGlossary term reviewers
childrenChild glossary term references

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list glossary terms