v1

latestOpenAPI 3.1.02026-07-2671117149.2 KB

Apis

Dictionaries

Get Dictionary Details

get/dictionaries/{dictionary_id}/full-details

Path parameters

dictionary_idinteger required

This parameter tells the API exactly which dictionary you're interested in. Each dictionary in the system has a unique numerical ID that serves as its primary identifier.

Query parameters

limitinteger nullable

Limit how many terms are returned when fetching the dictionary details. You can specify exactly how many terms you want to see. For example, setting limit=50 will return only the first 50 terms from the dictionary. This is especially useful for implementing pagination in user interfaces or when you only need a sample of the dictionary's content.

search_termstring nullable

When you provide a search term, the API acts like a search function within the dictionary. Rather than returning all terms, it will filter the results to show only those terms that match or contain your search string. This transforms the endpoint from a 'show me everything' request into a 'show me what I'm looking for' request, making it much more efficient when you're looking for specific terminology.

Response

Successful Response

idinteger

The Dictionary's Unique Identifier. This integer value serves as the dictionary's permanent address in the system. Once assigned, this ID never changes - It's how the system definitively identifies this particular collection of terms.

namestring

The Dictionary's Display Name. This string contains the human-readable name that identifies the dictionary to users. Unlike the ID, which is purely functional, the name is designed to be meaningful to people who are choosing which dictionary to work with.

descriptionstring nullable

Detailed Dictionary Information. This optional field can contain a longer explanation of what the dictionary covers, its intended audience, or special characteristics that set it apart from other dictionaries. The description might explain the scope of terms included, the expertise level assumed, or specific domains covered.

created_atstring date-time

Dictionary Creation Timestamp. This date-time value tells you exactly when someone first created this dictionary in the system. Understanding creation dates helps you gauge how established a dictionary is and can be useful for administrative purposes, auditing, or simply satisfying curiosity about a dictionary's history. The timestamp includes both date and time information, giving you precise historical context.

updated_atstring date-time

Last Modification Timestamp. Perhaps one of the most practically useful pieces of metadata, this timestamp shows when someone last made changes to the dictionary. This could mean adding new terms, modifying existing definitions, updating the dictionary's name or description, or any other modification. For applications where content freshness matters, this timestamp helps you and your users understand how current the dictionary's information might be.