Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
Glossaries

List glossary entries

Lists the entries in a glossary.

get/v2/glossaries/{glossary_key}/entries

Path parameters

glossary_keystring required

A user-provided key that uniquely identifies a glossary.

Example:eng-acronyms

The unique key of the glossary.

Query parameters

limitinteger

The maximum number of entries to return.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of glossary entries.

Example response

{
  "entries": [
    {
      "term": "k8s",
      "expansion": "Kubernetes"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}