Glossaries

List glossary terms

Get a list of glossary terms. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.

get/v1/glossaryTerms

Request

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

Query parameters

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

List glossary terms filtered by glossary identified by Id given in glossary parameter.

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

List glossary terms filtered by children of glossary term identified by Id given in parent parameter.

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

Fields requested in the returned resource

limitinteger

Limit the number glossary terms returned. (1 to 1000000, default = 10)

beforestring

Returns list of glossary terms before this cursor

afterstring

Returns list of glossary terms after this cursor

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

Include all, deleted, or non-deleted entities.

directChildrenOfstring

List glossary terms filtered to retrieve the first level/immediate children of the glossary term directChildrenOf parameter.

entityStatusstring

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

Response

List of glossary terms

warningsCountinteger

Changes

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