Glossary Entries
API endpoints for glossary entries
Manage the organisation glossary.
The glossary is the organisation’s own terms (service names, acronyms, internal
jargon) and what they mean. AI features use it so they understand those terms
wherever they appear.
Anyone with an API key can read the glossary. Creating, updating, reordering and
deleting entries requires the glossary_entries_manage role. The manage_settings
role also grants that access.
The glossary entry object
A glossary entry is one term an organisation has coined — an acronym, a service name, or a piece of internal jargon — and the description of what it means.
AI features use the glossary, in rank order, so they understand those terms. Lower ranks come first. Deleting an entry archives it, which frees the term so it can be coined again as a new entry.
Was this page helpful?
{
"created_at": "2021-08-17T13:28:57.801578Z",
"description": "Payment service provider that handles card authorisations",
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"item": "PSP",
"rank": 1,
"updated_at": "2021-08-17T13:28:57.801578Z"
}