Glossary
Manage custom terms translations used by the translation feature.
Was this helpful?
Manage custom terms translations used by the translation feature.
Was this helpful?
Was this helpful?
Define terms and specify their translations for different languages to ensure consistent wording.
Unique identifier of the glossary entry
{
"object": "glossary-entry",
"id": "text",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"createdAt": "2025-08-26T23:19:07.272Z",
"updatedAt": "2025-08-26T23:19:07.272Z",
"urls": {
"location": "https://example.com"
}
}
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
OK
GET /v1/orgs/{organizationId}/translations-glossary HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"object": "glossary-entry",
"id": "text",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"createdAt": "2025-08-26T23:19:07.272Z",
"updatedAt": "2025-08-26T23:19:07.272Z",
"urls": {
"location": "https://example.com"
}
}
]
}
The unique id of the organization
Glossary entries updated
Bad Request
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
The unique id of the organization
The unique id of the glossary entry
OK
Not Found
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-08-26T23:19:07.272Z",
"updatedAt": "2025-08-26T23:19:07.272Z",
"urls": {
"location": "https://example.com"
}
}