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

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
glossaries = Glossaries.list(limit=50)
for g in glossaries.data:
    print(f"{g.fullyQualifiedName}")

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

# With fields
glossaries = Glossaries.list(
    fields=["owners", "tags", "reviewers"],
    limit=50
)

for g in glossaries.data:
    print(f"{g.fullyQualifiedName}")
    if g.reviewers:
        print(f"  Reviewers: {[r.name for r in g.reviewers]}")
{
  "data": [
    {
      "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
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Glossaries

List all glossaries with optional filtering and pagination.

Query Parameters

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, reviewers. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/glossaries
from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
glossaries = Glossaries.list(limit=50)
for g in glossaries.data:
    print(f"{g.fullyQualifiedName}")

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

# With fields
glossaries = Glossaries.list(
    fields=["owners", "tags", "reviewers"],
    limit=50
)

for g in glossaries.data:
    print(f"{g.fullyQualifiedName}")
    if g.reviewers:
        print(f"  Reviewers: {[r.name for r in g.reviewers]}")
{
  "data": [
    {
      "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
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

Returns

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

Response

data
array
Array of glossary objects.
paging
object
Pagination information.

Supported Fields

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

Error Handling

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