{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"32065a0a-1433-4805-8ef5-6a12bc87742a","name":"Lexeri API","description":"The Lexeri API gives integrations access to one termbase: search and maintain its terms, list its topics,\nexport it and check texts against it. It is a REST API that speaks JSON.\n\n## Base URL\n\n`https://terms.lexeri.com`\n\n## Authentication\n\nEvery request carries an API token in the `Authorization` header:\n\n```\nAuthorization: Bearer <api token>\n```\n\nAPI tokens are created in the termbase settings (tab **API**) by users who may create them there — by default\nadmins and terminology managers. A token belongs to **one termbase** and acts on behalf of the user it was\ncreated for:\n\n- It can do at most what that user may do in the termbase **today**. If the user is removed from the termbase or\n  loses a permission, the token loses it too.\n- It expires on the date chosen at creation (or never). Expired or revoked tokens are answered with `401`.\n- The termbase identifier in a path must be the token's own termbase.\n\n### Scopes\n\nA token is created with a set of scopes. An endpoint that needs a scope the token lacks answers `401` with\n`{\"message\": \"required scope missing: <scope>\"}`.\n\n| Scope | Allows |\n| --- | --- |\n| `show`, `read` | Reading the termbase, its terms, versions, usage examples and topics. Every token has them. |\n| `edit_terms` | Creating, changing and deleting terms and usage examples. |\n| `edit_term_entries` | Creating topics. |\n| `export_termbase` | Creating and downloading exports. |\n| `check_text` | Checking texts for terms (live check). |\n\nTokens can carry further scopes (`request_terms`, `manage_term_requests`, `edit_ontologies`, `edit_termbase`)\nfor endpoints that are not part of this documentation yet.\n\n## Changes go live immediately\n\nTerms created, changed or deleted through the API are published right away. They do not pass through a\ntask or term request.\n\n## Errors\n\nErrors are answered with a JSON body carrying a `message`:\n\n```json\n{\"message\": \"required scope missing: edit_terms\"}\n```\n\n| Status | Meaning |\n| --- | --- |\n| `401` | The token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks a required scope. |\n| `404` | The resource does not exist or does not belong to the token's termbase. |\n| `406` | A required parameter is missing or empty: `param is missing or the value is empty or invalid: <name>`. |\n| `422` | A parameter has an invalid value. Exports answer with `{\"errors\": {\"<field>\": [\"<problem>\"]}}` instead. |\n| `500` | Unexpected error. Please contact us if it persists. |\n\nMessages are meant for humans and may change; do not parse them.\n\n## Pagination\n\n`GET /terms` is paginated with `page` (from 1) and `per_page` (at most 500, default 500). Every response\ncarries the headers `x-page`, `x-per-page`, `x-total` and `x-total-pages`.\n\n## Locale codes\n\nLanguages are identified by codes such as `de` or `en`, optionally with a region, e.g. `de-CH` or `en-GB`.\nThe supported languages are listed in the help center:\n[Unterstützte Sprachen](https://support.lexeri.com/hc/de/articles/18364416223517-Unterst%C3%BCtzte-Sprachen).\n\n## Usage states of terms\n\nA term's `state` is one of the built-in states `preferred`, `admitted`, `deprecated` and `not_recommended`,\nor the identifier of a custom state of the termbase (`custom_term_states` in `GET /termbases/{identifier}`).\n\n## Custom fields\n\nA termbase can define its own fields for term entries and terms. Their definitions are part of\n`GET /termbases/{identifier}` (`term_entry_fields`, `term_fields`). Values are keyed by the field's\n`identifier`: write them with `fields` (terms) or `term_entry_fields` (new term entries), filter the term list\nwith `term_field_<identifier>` and `term_entry_field_<identifier>`.\n\n## Help\n\nQuestions and feedback: [info@lexeri.com](mailto:info@lexeri.com)\n\n## Changelog\n\n**October 2026**\n\n- Rebuilt from an OpenAPI specification that is checked against the API in our test suite.\n- Removed endpoints that did not work with API tokens: topic details, updating and deleting topics, topic images,\n  reference documents, and updating or creating termbases. They will return once they support API tokens.\n- Corrected status codes: listing exports answers `200`, creating a term `200`. Creating an export always\n  creates a new one.\n- Documented the actual fields of every response and the filters of `GET /terms`.\n- `GET /terms` honours `per_page` (at most 500), accepts `fields` as a list and returns only published terms.\n- The live check requires the scope `check_text`. Unknown export types are rejected with `422`.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3063999","team":72255,"collectionId":"32065a0a-1433-4805-8ef5-6a12bc87742a","publishedId":"2sBYHRUgQF","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3063999/2sBYHRUgQF","privateUrl":"https://go.postman.co/documentation/3063999-32065a0a-1433-4805-8ef5-6a12bc87742a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.8","publishDate":"2026-10-13T10:03:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Lexeri Production","id":"9bbe8147-83ba-4aa5-bc58-e2c42afc247e","owner":"3063999","values":[{"key":"base_url","value":"https://terms.lexeri.com","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/25210ee12e9b2d868c5cebb2f13018be47d5b65c28fc1591baf2515ab69bb5e2","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Lexeri Production","value":"3063999-9bbe8147-83ba-4aa5-bc58-e2c42afc247e"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYHRUgQF"}