v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Lexicons

Get a Lexicon

Gets a Lexicon from a Project.

get/v2.0/lexicons/{lexiconId}

Path parameters

lexiconIdstring required

The unique identifier for the Lexicon.

Query parameters

metaOnlytrue | false

If set to true, returns only Lexicon metadata.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns Lexicon Object

namestring

The name of the lexicon

descriptionstring

A meaningful description of the lexicon

referenceIdstring uuid

{"stackTrail":"paths:/v2.0/lexicons/{lexiconId}:get:responses:200:content:application/json:schema:properties:values","oasType":"schema","type":"unknown"}

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}