Retrieves comprehensive details for a specific dictionary, including all terms and their definitions. Supports optional filtering and pagination to help you find exactly what you need.
The x-api-key
is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
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.
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.
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.
Successful Response
The response is of type object
.