v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB

Termbase

Get Termbase

Retrieves a termbase by identifier.

get/termbases/{termbaseId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

idstring required

The identifier of the termbase.

namestring

<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>

descriptionstring nullable

The description of the termbase.

copyrightstring nullable

The copyright of the termbase.

numberOfEntriesnumber

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)

createdAtstring 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

lastModifiedAtstring 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

Example response

{
  "createdAt": "2022-01-12T12:00:00Z",
  "lastModifiedAt": "2022-01-12T12:00:00Z"
}