Explore how adaptive content transforms your docs into a dynamic, tailored experience for every user.
Read the docs
PricingLog inSign up

Glossary

Manage custom terms translations used by the translation feature.

Define terms and specify their translations for different languages to ensure consistent wording.

The GlossaryEntry object

Attributes
objectstring · enumRequiredPossible values:
idstringRequired

Unique identifier of the glossary entry

createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired

The GlossaryEntry object

{
  "object": "glossary-entry",
  "id": "text",
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2025-10-30T13:40:39.855Z",
  "updatedAt": "2025-10-30T13:40:39.855Z",
  "urls": {
    "location": "https://example.com"
  }
}

List glossary entries

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
Responseall of
get
/orgs/{organizationId}/translations-glossary
GET /v1/orgs/{organizationId}/translations-glossary HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "glossary-entry",
      "id": "text",
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "2025-10-30T13:40:39.855Z",
      "updatedAt": "2025-10-30T13:40:39.855Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Update glossary entries

put
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Body
Responses
204

Glossary entries updated

No content
put
/orgs/{organizationId}/translations-glossary
PUT /v1/orgs/{organizationId}/translations-glossary HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "operations": [
    {
      "type": "insert",
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}
No content

Get a glossary entry by its ID

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

glossaryEntryIdstringRequired

The unique id of the glossary entry

Responses
200

OK

application/json
get
/orgs/{organizationId}/translations-glossary/{glossaryEntryId}
GET /v1/orgs/{organizationId}/translations-glossary/{glossaryEntryId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "glossary-entry",
  "id": "text",
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2025-10-30T13:40:39.855Z",
  "updatedAt": "2025-10-30T13:40:39.855Z",
  "urls": {
    "location": "https://example.com"
  }
}

Last updated

Was this helpful?