Skip to main content
GET
GET /v1/glossaryTerms/{id}

Retrieve a Glossary Term

Get a single glossary term by its unique ID or fully qualified name.

Get by ID

string
required
UUID of the glossary term to retrieve.
string
Comma-separated list of fields to include (e.g., owners,tags,domains,relatedTerms,reviewers,children).
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/glossaryTerms/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the glossary term (e.g., BusinessGlossary.Revenue).
string
Comma-separated list of fields to include: owners, tags, domains, relatedTerms, reviewers, children.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/glossaryTerms/{id}

Returns

Returns a glossary term object with all requested fields populated.

Response

string
Unique identifier for the glossary term (UUID format).
string
Glossary term name.
string
Fully qualified name of the glossary term.
string
Human-readable display name.
string
Description of the glossary term in Markdown format.
array
List of synonym strings.
object
Reference to the parent glossary.
array
Child term references. Only included when fields contains children.
Related term references. Only included when fields contains relatedTerms.
array
List of owners. Only included when fields contains owners.
array
Classification tags. Only included when fields contains tags.
number
Version number for the entity.

Error Handling