Skip to main content
GET
GET /v1/glossaryTerms

List Glossary Terms

List all glossary terms with optional filtering and pagination.

Query Parameters

string
Filter by glossary ID (universally unique identifier, or UUID).
string
Filter by parent glossary term ID (UUID). Returns only direct children of that term.
string
Fully qualified name (FQN) of a glossary or glossary term. Returns only the terms exactly one level below it. Pass a glossary FQN to get its top-level terms, or a term FQN to get that term’s direct children.
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.
glossary and parent take IDs (UUIDs), not fully qualified names. directChildrenOf takes a fully qualified name. An empty parent= is ignored and doesn’t filter for terms without a parent. To list only the top-level terms of a glossary, pass the glossary’s fully qualified name:
To list the direct children of a term, pass the term’s fully qualified name:
GET /v1/glossaryTerms

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

array
Array of glossary term objects.
object
Pagination information.

Supported Fields


Error Handling