---
title: "Get Termbase"
method: GET
path: "/termbases/{termbaseId}"
tags: ["Termbase"]
---

# Get Termbase

`GET /termbases/{termbaseId}`

Retrieves a termbase by identifier.

## Query parameters

- `fields` string

## Headers

- `Authorization` string, required
- `X-LC-Tenant` string, required

## Response `200`

OK

- Termbase — The termbase.
  - `id` string, required — The identifier of the termbase.
  - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The name of the termbase.</div>
  - `description` string, nullable — The description of the termbase.
  - `copyright` string, nullable — The copyright of the termbase.
  - `location` FolderV2 — Folder used for resource storage.
    - `id` string, required — The folder identifier.
    - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The name of the folder.</div>
    - `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
    - `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
      - `id` string, required — The folder identifier.
      - `name` string, required — The name of the folder.
      - `location` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>The location identifier.
      - `hasParent` boolean, nullable — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>Indicates if the folder has a parent folder.
  - `termbaseStructure` TermbaseStructure — The termbase structure.
    - `languages` Language[] — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The languages of the termbase.</div>
      - `languageCode` string, required — Language code. ex: "en-US", "de-DE".
      - `englishName` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">Human readable name.</div>
      - `direction` string
      - `parentLanguageCode` string
      - `defaultSpecificLanguageCode` string
      - `isNeutral` boolean, nullable
    - `fields` TermbaseField[] — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The termbase fields. (Not available for List Termbases endpoint).</div>
      - `id` string, required — The identifier of the termbase field.
      - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The name of the termbase field.</div>
      - `description` string, nullable — The description of the termbase field
      - `type` 'system' | 'userDefined' — The type of the termbase field - system or userDefined.
      - `level` 'entry' | 'language' | 'term' — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The level of which this field applies.</div>
      - `dataType` 'text' | 'double' | 'date' | 'picklist' | 'boolean' — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The data type of the field.</div>
      - `pickListValues` string[] — The pick list options. Only if dataType is "picklist".
      - `allowCustomValues` boolean — Specifies if the field allows custom values.
      - `allowMultiple` boolean — Specifies if the field can be used multiple times.
      - `isMandatory` boolean — Specifies if the field is mandatory.
  - `numberOfEntries` number — The number of entries included in the termbase. (Not available for List Termbases endpoint)
  - `status` 'ready' | 'processingContent' | 'exportingContent' | 'deletingContent' — The status of the termbase. (Not available for List Termbases endpoint)
  - `createdAt` string, date-time — The date and time when the termbase was created. (Not available for List Termbases endpoint) <br> UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sss
  - `lastModifiedAt` string, date-time — The date and time when the termbase was last updated. (Not available for List Termbases endpoint) <br> UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sss

## Other responses

- `401` — The user could not be identified.
- `403` — Error codes: * "forbidden": - The authenticated user is not allowed to read the resource. * "entitlementMissing": - Your subscription does not include access to the requested type of benefit.

---

[API](https://skmtc.net/rws/apis/trados-cloud-platform-api.md) · [All operations](https://skmtc.net/rws/apis/trados-cloud-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rws/trados-cloud-platform-api/revisions/d42dac7c28a3/schema)