Translations | GitBook Documentation

The TranslationSettings object

Attributes

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier of the translation settings

titlestring · min: 1 · max: 100Required

Title of the translation settings

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

The TranslationSettings object

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-05-05T09:58:55.010Z",
  "updatedAt": "2025-05-05T09:58:55.010Z",
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

List all the translation settings

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

GET /v1/orgs/{organizationId}/translations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "translation-settings",
      "id": "text",
      "title": "text",
      "languages": [
        "en"
      ],
      "createdAt": "2025-05-05T09:58:55.010Z",
      "updatedAt": "2025-05-05T09:58:55.010Z",
      "permissions": {
        "view": true,
        "edit": true
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a translation settings

post

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestringRequired

The title of the translation settings

Responses

201

Translation settings has been created

application/json

400

Bad Request

application/json

post

POST /v1/orgs/{organizationId}/translations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-05-05T09:58:55.010Z",
  "updatedAt": "2025-05-05T09:58:55.010Z",
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a translation settings by its ID

get

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

translationSettingsIdstringRequired

The unique id of the translation settings

Responses

200

OK

application/json

404

No matching translation settings found

application/json

get

GET /v1/orgs/{organizationId}/translations/{translationSettingsId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-05-05T09:58:55.010Z",
  "updatedAt": "2025-05-05T09:58:55.010Z",
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Update a translation settings

put

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

translationSettingsIdstringRequired

The unique id of the translation settings

Body

titlestringRequired

The title of the translation settings

Responses

200

Translation settings has been updated

application/json

400

Bad Request

application/json

put

PUT /v1/orgs/{organizationId}/translations/{translationSettingsId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-05-05T09:58:55.010Z",
  "updatedAt": "2025-05-05T09:58:55.010Z",
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a translation settings

delete

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

translationSettingsIdstringRequired

The unique id of the translation settings

Responses

205

Translation settings has been deleted

delete

DELETE /v1/orgs/{organizationId}/translations/{translationSettingsId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

205

Translation settings has been deleted

No content