Get Glossary Item
GET /obp/v7.0.0/api/glossary/TITLE
OBPv7.0.0-getGlossaryItem No role required Documentation
Returns one Glossary Item — the Dynamic Item with this title if there is one, and the static Item shipped with the API otherwise. That is the same precedence the Glossary itself uses, so this is always the text the Glossary is serving.
Reading an Item costs a fraction of the whole Glossary, so an agent or a page that wants one entry should ask for it here.
The title is matched case insensitively, with hyphens, underscores, slashes and spaces all treated alike: /api/glossary/Signal-Channels finds the Item titled Signal Channels. (A title containing a slash cannot be written literally in a path, and %2F does not survive most proxies, which is why the slash is folded in too.)
is_dynamic says which kind you got. A static Item has no glossary_item_id, created_by_user_id, created_at or updated_at, and cannot be updated or deleted — create a Dynamic Item with overrides_static_item: true to displace it.
Optional query parameter:
expanded—trueby default: Glossary Items quote each other through placeholders, and the default expands them into the text a reader wants. Passexpanded=falseto get the description exactly as it was authored, which is what an editor must send back to PUT.
Returns 404 only when neither a Dynamic nor a static Glossary Item has this title.
User Authentication is Optional. The User need not be logged in.
URL Parameters:
TITLE: Dr.
JSON response body fields (11)
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- html
- html format content
- is_dynamic
- is_dynamic
- markdown
- overrides_static_item
- overrides_static_item
- shadows_static_glossary_item
- shadows_static_glossary_item
- title
- Dr.
- created_at
- created_at
- created_by_user_id
- glossary_item_id
- glossary_item_id
- updated_at
- updated_at
Example success response
{
"glossary_item_id": "8f2b1c44-1f2a-4c3d-9a7e-5b6c7d8e9f01",
"title": "Bank.bank_id",
"description": {
"markdown": "The unique identifier of the Bank on this OBP instance.",
"html": "<p>The unique identifier of the Bank on this OBP instance.</p>"
},
"is_dynamic": true,
"overrides_static_item": true,
"shadows_static_glossary_item": true,
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_at": "2026-10-21T01:45:41Z",
"updated_at": "2026-10-21T01:45:41Z"
}Possible errors (2)
- OBP-30571: Glossary Item not found. Please specify a valid value for TITLE.
- OBP-50000: Unknown Error.