Developers

Exports

Exports write the termbase to a file. They run in the background: create an export, then poll it until state is finished and download the file from download_url.

TypeFormat
tbxTBX, the standard exchange format for terminology.
xlsxExcel workbook, one term per row. Columns can be chosen with fields.
xlsx_entriesExcel workbook, one term entry per row. Columns can be chosen with fields.
memoq_csvCSV for memoQ.
smartling_tbxTBX for Smartling.
trados_tbxTBX for RWS Trados.
crowdin_tbxTBX for Crowdin.
phrase_tbxTBX for Phrase.
term_star_tbxTBX for STAR TermStar.
st4_tbxTBX for SCHEMA ST4.
congree_tbxTBX for Congree.
deepl_csvCSV for importing glossaries on the DeepL website.
deepl_api_csvCSV for the DeepL glossary API, one language pair (source_locale_code → first of locale_codes).
alugha_csvCSV for alugha.
images_zipAll images of the termbase as a ZIP file. Ignores languages and filters.
Base URLhttps://api.lexeri.comAuthenticationBearer tokenFormatJSON

Endpoints of this resource

GET/termbases/:identifier/exports

List the exports

Required scope:export_termbase

Returns the exports of the termbase that are still stored. Exports are deleted two months after their creation, exports of an export schedule after three days.

Path parameters

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

Responses

  • 200 OKThe exports.
  • 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.
Fields of each item (12)
identifierstring · uuidrequired
typestringrequired
The file format (ExportType).
statestringrequired
new waiting, running being written, finished ready to download, failed.
locale_codesstring[]required
default_locale_codestring | null
The source language.
filtersobject | null
The filters the export was created with.
fieldsstring[] | null
The columns of an xlsx or xlsx_entries export; null for the default columns.
filenamestring | null
Name of the file, once finished.
download_urlstring | null
Download link of the file once finished, valid for one hour from the response.
userobject | []
Who created it; an empty array for exports without a user.
6 fields
identifierstring · uuidrequired
namestringrequired
first_namestring | null
last_namestring | null
emailstring | null
image_urlstring | null
URL of the user's avatar.
created_atstring · date-timerequired
updated_atstring · date-timerequired
curl https://api.lexeri.com/termbases/6b0f3c8e-2f4d-4c1a-9e7b-1d2a3c4b5e6f/exports \  -H "Authorization: Bearer $LEXERI_API_TOKEN"
200 OKExample response
[  {    "identifier": "8f12f058-17e3-4ba5-a729-6b54ded31b9c",    "type": "xlsx",    "state": "finished",    "locale_codes": [      "de",      "en"    ],    "default_locale_code": "de",    "filters": {      "topic_identifiers": [        "23f9c4bd-9bb4-47f0-9950-33551a70ec70"      ]    },    "fields": [      "term_entry_identifier",      "value",      "state",      "usage",      "definition",      "term_entry.f1e2d3c4"    ],    "filename": "Bauphysik.xlsx",    "download_url": "https://files.lexeri.com/v2/documents/3f9c1d2e-7b4a-4c8e-9a51-2d6f0e8b7c43/download?token=eyJhbGciOiJIUzI1NiJ9.example",    "user": {      "identifier": "ecb20516-ae20-44bf-8c91-0503fa7bd59a",      "email": "anna.berger@example.com",      "first_name": "Anna",      "last_name": "Berger",      "name": "Anna Berger",      "image_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=identicon&s=300"    },    "created_at": "2026-10-11T20:19:09.614Z",    "updated_at": "2026-10-11T20:21:42.103Z"  }]

POST/termbases/:identifier/exports

Create an export

Required scope:export_termbase

Starts an export in the background and returns it with state: new. Poll GET /exports/{identifier} until state is finished (or failed); then download_url leads to the file. Every request creates a new export.

The filters narrow down the term entries that are exported; they combine with AND.

Path parameters

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

Body parameters · JSON

typestringDefault: tbx
The file format, see the table in the description of the Exports section.Allowed values: tbx, xlsx, xlsx_entries, memoq_csv, smartling_tbx, trados_tbx, crowdin_tbx, phrase_tbx, term_star_tbx, st4_tbx, congree_tbx, deepl_csv, deepl_api_csv, alugha_csv, images_zip
locale_codesstring[]
Languages to export. Defaults to all languages of the termbase.
source_locale_codestring
The source language, for formats that have one (deepl_api_csv, TBX dialects). Defaults to the first of locale_codes.
fieldsstring[]
Only for xlsx and xlsx_entries: the columns, in the exporter's order. Term entry: term_entry_identifier, topics, tags, definition, definition_source. Term: term_identifier, value, term_type, state, usage, grammatical_attributes, usage_examples, source. Custom fields: term_entry.<identifier>, term.<identifier>, locale.<identifier>. Omitted: the default columns.
topic_identifiersstring[] · uuid
Only term entries in one of these topics.
tagsstring[]
Only term entries carrying all of these tags.
term_statesstring[]
Only terms in one of these usage states.
missing_locale_codestring
Only term entries without a term in this language.
last_updated_afterstring · date
Only term entries changed on or after this day.

Responses

  • 201 CreatedThe export, not yet run.
  • 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.
  • 422 Unprocessable EntityThe export cannot be created as requested.
Fields of the response (12)
identifierstring · uuidrequired
typestringrequired
The file format (ExportType).
statestringrequired
new waiting, running being written, finished ready to download, failed.
locale_codesstring[]required
default_locale_codestring | null
The source language.
filtersobject | null
The filters the export was created with.
fieldsstring[] | null
The columns of an xlsx or xlsx_entries export; null for the default columns.
filenamestring | null
Name of the file, once finished.
download_urlstring | null
Download link of the file once finished, valid for one hour from the response.
userobject | []
Who created it; an empty array for exports without a user.
6 fields
identifierstring · uuidrequired
namestringrequired
first_namestring | null
last_namestring | null
emailstring | null
image_urlstring | null
URL of the user's avatar.
created_atstring · date-timerequired
updated_atstring · date-timerequired
curl -X POST https://api.lexeri.com/termbases/6b0f3c8e-2f4d-4c1a-9e7b-1d2a3c4b5e6f/exports \  -H "Authorization: Bearer $LEXERI_API_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "type": "xlsx",    "locale_codes": ["de", "en"],    "source_locale_code": "de",    "fields": ["term_entry_identifier", "value", "state", "usage", "definition", "term_entry.f1e2d3c4"],    "topic_identifiers": ["23f9c4bd-9bb4-47f0-9950-33551a70ec70"]  }'
201 CreatedExample response
{  "identifier": "8f12f058-17e3-4ba5-a729-6b54ded31b9c",  "type": "xlsx",  "state": "new",  "locale_codes": [    "de",    "en"  ],  "default_locale_code": "de",  "filters": {    "topic_identifiers": [      "23f9c4bd-9bb4-47f0-9950-33551a70ec70"    ]  },  "fields": [    "term_entry_identifier",    "value",    "state",    "usage",    "definition",    "term_entry.f1e2d3c4"  ],  "filename": null,  "download_url": null,  "user": {    "identifier": "ecb20516-ae20-44bf-8c91-0503fa7bd59a",    "email": "anna.berger@example.com",    "first_name": "Anna",    "last_name": "Berger",    "name": "Anna Berger",    "image_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=identicon&s=300"  },  "created_at": "2026-10-11T20:19:09.614Z",  "updated_at": "2026-10-11T20:19:09.614Z"}

GET/exports/:identifier

Get an export

Required scope:export_termbase

Returns the export. Once state is finished, download_url leads to the file. The URL is valid for one hour from the response; request the export again for a fresh one.

Path parameters

identifierstring · uuidrequired
Identifier of the export.

Responses

  • 200 OKThe export.
  • 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.
Fields of the response (12)
identifierstring · uuidrequired
typestringrequired
The file format (ExportType).
statestringrequired
new waiting, running being written, finished ready to download, failed.
locale_codesstring[]required
default_locale_codestring | null
The source language.
filtersobject | null
The filters the export was created with.
fieldsstring[] | null
The columns of an xlsx or xlsx_entries export; null for the default columns.
filenamestring | null
Name of the file, once finished.
download_urlstring | null
Download link of the file once finished, valid for one hour from the response.
userobject | []
Who created it; an empty array for exports without a user.
6 fields
identifierstring · uuidrequired
namestringrequired
first_namestring | null
last_namestring | null
emailstring | null
image_urlstring | null
URL of the user's avatar.
created_atstring · date-timerequired
updated_atstring · date-timerequired
curl https://api.lexeri.com/exports/8f12f058-17e3-4ba5-a729-6b54ded31b9c \  -H "Authorization: Bearer $LEXERI_API_TOKEN"
200 OKExample response
{  "identifier": "8f12f058-17e3-4ba5-a729-6b54ded31b9c",  "type": "xlsx",  "state": "finished",  "locale_codes": [    "de",    "en"  ],  "default_locale_code": "de",  "filters": {    "topic_identifiers": [      "23f9c4bd-9bb4-47f0-9950-33551a70ec70"    ]  },  "fields": [    "term_entry_identifier",    "value",    "state",    "usage",    "definition",    "term_entry.f1e2d3c4"  ],  "filename": "Bauphysik.xlsx",  "download_url": "https://files.lexeri.com/v2/documents/3f9c1d2e-7b4a-4c8e-9a51-2d6f0e8b7c43/download?token=eyJhbGciOiJIUzI1NiJ9.example",  "user": {    "identifier": "ecb20516-ae20-44bf-8c91-0503fa7bd59a",    "email": "anna.berger@example.com",    "first_name": "Anna",    "last_name": "Berger",    "name": "Anna Berger",    "image_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=identicon&s=300"  },  "created_at": "2026-10-11T20:19:09.614Z",  "updated_at": "2026-10-11T20:21:42.103Z"}