Glossaries

Search glossary terms with pagination

Search glossary terms by name, display name, or description with server-side pagination. This endpoint provides efficient search functionality for glossaries with large numbers of terms.

get/v1/glossaryTerms/search

Request

Base URL: https://demo.getcollate.io/api
URL: https://demo.getcollate.io/api/v1/glossaryTerms/search
Auth: HTTP bearer

Query parameters

qstring

Search query for term names, display names, or descriptions

glossarystring uuid

Filter by glossary ID

glossaryFqnstring

Filter by glossary FQN

parentstring uuid

Filter by parent term ID

parentFqnstring

Filter by parent term FQN

limitinteger

Limit the number of terms returned (1 to 1000, default = 50)

offsetinteger

Offset for pagination (default = 0)

fieldsstring

Example:children,relatedTerms,reviewers,owners,tags,usageCount,domains,extension,childrenCount

Fields requested in the returned terms

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

entityStatusstring

Filter by entity status (comma-separated: Approved,Draft,In Review,Rejected,Deprecated,Unprocessed)

Response

List of matching glossary terms

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.