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

configure(
    host="https://your-company.getcollate.io/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"]
)

{
  "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

​
id
string
required
UUID of the glossary to retrieve.
​
fields
string
Comma-separated list of fields to include (e.g., owners,tags,domains,reviewers).
​
include
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.
​
fqn
string
required
Fully qualified name of the glossary (e.g., BusinessGlossary).
​
fields
string
Comma-separated list of fields to include: owners, tags, domains, reviewers.
​
include
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.getcollate.io/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"]
)

{
  "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

​
id
string
Unique identifier for the glossary (UUID format).
​
name
string
Glossary name.
​
fullyQualifiedName
string
Fully qualified name of the glossary.
​
displayName
string
Human-readable display name.
​
description
string
Description of the glossary in Markdown format.
​
mutuallyExclusive
boolean
Whether terms in this glossary are mutually exclusive.
​
owners
array
List of owners. Only included when fields contains owners.
​
tags
array
Classification tags. Only included when fields contains tags.
​
domains
array
Domain assignments. Only included when fields contains domains.
​
reviewers
array
Reviewers. Only included when fields contains reviewers.
​
version
number
Version number for the entity.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this glossary
404NOT_FOUNDGlossary with given ID or FQN does not exist