Developers

Termbases

The termbase the API token belongs to.

Basis-URLhttps://api.lexeri.comAuthentifizierungBearer-TokenFormatJSON

Endpunkte dieser Ressource

GET/termbases/:identifier

Get the termbase

Returns the termbase of the API token: its languages, custom field definitions, custom usage states and topics.

Pfad-Parameter

identifierstring · uuidPflicht
Identifier of the termbase. Must be the termbase of the API token.

Query-Parameter

translation_locale_codestring
Language in which names of languages and titles of topics are returned, e.g. en.

Antworten

  • 200 OKThe termbase.
  • 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
  • 404 Not FoundNot found in the token's termbase.
Felder der Antwort (19)
identifierstring · uuidPflicht
namestringPflicht
descriptionstring | null
The description in translation_locale_code, else in the source language.
descriptions{ [key]: string | null }
Description by locale code.
source_locale_codestring | nullPflicht
The language terms are usually defined in first.
locale_codesstring[]Pflicht
The languages of the termbase.
localesobject[]Pflicht
4 Felder
codestringPflicht
The locale code.
namestring | nullPflicht
Name of the language, in translation_locale_code if given.
plural_formsstring | null
The grammatical numbers the language distinguishes, comma-separated (one,other). An empty string means the language has no grammatical number, null that it is unknown.
tagsstring[]
number_of_termsinteger
Published terms. Updated within an hour.
terms_updated_atstring · date-time | null
When a term was last changed.
tagsstring[]
The tags used on term entries.
term_entry_fieldsobject[]Pflicht
Custom fields of term entries.
8 Felder
identifierstringPflicht
Key of the field's values in fields and term_entry_fields, and in the filters of GET /terms.
namestringPflicht
descriptionstring | null
typestringPflicht
string one line, text several lines, picklist one of picklist_options (several with multiple_selection), date as YYYY-MM-DD, number, boolean.
picklist_optionsstring[]
The values a picklist field takes.
multiple_selectionboolean | null
Whether a picklist field takes several values, sent as an array.
requiredboolean | null
Whether a value is required when creating or changing.
searchableboolean | null
Whether the global search in the Lexeri app looks into the field.
term_fieldsobject[]Pflicht
Custom fields of terms.
8 Felder
identifierstringPflicht
Key of the field's values in fields and term_entry_fields, and in the filters of GET /terms.
namestringPflicht
descriptionstring | null
typestringPflicht
string one line, text several lines, picklist one of picklist_options (several with multiple_selection), date as YYYY-MM-DD, number, boolean.
picklist_optionsstring[]
The values a picklist field takes.
multiple_selectionboolean | null
Whether a picklist field takes several values, sent as an array.
requiredboolean | null
Whether a value is required when creating or changing.
searchableboolean | null
Whether the global search in the Lexeri app looks into the field.
locale_fieldsobject[]
Custom fields of a term entry per language.
8 Felder
identifierstringPflicht
Key of the field's values in fields and term_entry_fields, and in the filters of GET /terms.
namestringPflicht
descriptionstring | null
typestringPflicht
string one line, text several lines, picklist one of picklist_options (several with multiple_selection), date as YYYY-MM-DD, number, boolean.
picklist_optionsstring[]
The values a picklist field takes.
multiple_selectionboolean | null
Whether a picklist field takes several values, sent as an array.
requiredboolean | null
Whether a value is required when creating or changing.
searchableboolean | null
Whether the global search in the Lexeri app looks into the field.
custom_term_statesobject[]
Usage states of the termbase besides the built-in ones.
4 Felder
identifierstringPflicht
The value of a term's state.
titles{ [key]: string }
Title of the state, by locale code.
descriptions{ [key]: string | null }
Description of the state, by locale code.
replaceableboolean
Whether the term check suggests the preferred term instead of a term in this state.
topicsobject[]Pflicht
All topics, nested ones included.
5 Felder
identifierstring · uuidPflicht
titles{ [key]: string }Pflicht
Title by locale code.
titlestring | nullPflicht
The title in translation_locale_code, else in the first language that has one.
is_root_topicbooleanPflicht
Whether the topic is at the top level.
has_childrenbooleanPflicht
Whether topics are nested below it.
featuresstring[]
Optional features enabled for the termbase.
subscriptionobject | null
3 Felder
levelstringPflicht
The plan, e.g. team or enterprise.
starts_atstring · date-time | null
expires_atstring · date-time | null
Null for a subscription without end.
created_atstring · date-timePflicht
updated_atstring · date-timePflicht
curl https://api.lexeri.com/termbases/6b0f3c8e-2f4d-4c1a-9e7b-1d2a3c4b5e6f \  -H "Authorization: Bearer $LEXERI_API_TOKEN"
200 OKBeispielantwort
{  "identifier": "6b0f3c8e-2f4d-4c1a-9e7b-1d2a3c4b5e6f",  "name": "Bauphysik",  "description": "Terminologie für Bauphysik und Gebäudetechnik",  "descriptions": {    "de": "Terminologie für Bauphysik und Gebäudetechnik",    "en": "Terminology for building physics"  },  "source_locale_code": "de",  "locale_codes": [    "de",    "en"  ],  "locales": [    {      "code": "de",      "name": "Deutsch",      "plural_forms": "one,other",      "tags": []    },    {      "code": "en",      "name": "Englisch",      "plural_forms": "one,other",      "tags": []    }  ],  "number_of_terms": 3,  "terms_updated_at": "2026-10-11T20:19:08.852Z",  "tags": [    "Normen"  ],  "term_entry_fields": [    {      "identifier": "f1e2d3c4",      "name": "Produktbereich",      "description": "Bereich, dem der Begriff zugeordnet ist",      "type": "picklist",      "picklist_options": [        "Dämmung",        "Fenster",        "Lüftung"      ],      "required": false,      "multiple_selection": false,      "searchable": true    }  ],  "term_fields": [    {      "identifier": "a9b8c7d6",      "name": "Hinweis für Übersetzer",      "description": null,      "type": "text",      "picklist_options": [],      "required": false,      "multiple_selection": false,      "searchable": false    }  ],  "locale_fields": [],  "custom_term_states": [],  "topics": [    {      "identifier": "23f9c4bd-9bb4-47f0-9950-33551a70ec70",      "titles": {        "de": "Gebäudehülle",        "en": "Building envelope"      },      "title": "Gebäudehülle",      "is_root_topic": true,      "has_children": false    }  ],  "features": [],  "subscription": {    "level": "enterprise",    "starts_at": "2026-01-01T00:00:00.000Z",    "expires_at": "2027-01-01T00:00:00.000Z"  },  "created_at": "2026-10-11T20:19:08.778Z",  "updated_at": "2026-10-11T20:19:08.782Z"}