Glossary

Read access to glossary terms. limit bounds the result set: it defaults to 50 and may not exceed 200. There is no paging - narrow the search with the filters instead.

Each term carries a reference in the glossaryPath|termName form. That is the same reference form used by import and export, so a reference read here can be fed straight back into an import.

The glossary filter is a substring match over the glossary path, so filtering on a parent glossary also returns the terms of its child glossaries. It matches the same /-separated form the glossary field returns, so a value read from a response can be fed straight back in as a filter.

Results are flat: terms nested under other terms are returned alongside top-level ones.

Search terms

/api/v1/glossary/terms/search

Returns glossary terms matching the given filters

Request parameters

{
  "name": "example",
  "description": "example",
  "freeText": "example",
  "glossary": "example",
  "limit": 96
}

Responses

[
  {
    "id": 96,
    "name": "example",
    "reference": "example",
    "glossary": "example",
    "type": "example",
    "color": "example",
    "description": "example",
    "customFields": [
      {
        "name": "example",
        "values": [
          "example"
        ]
      }
    ]
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

09 October 2026