Skip to main content
GET
/
v2.0
/
locales
/
{localeId}
Reads a Locale
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "name": "English",
  "primary": true,
  "nluLanguage": "en-US",
  "fallbackLocaleReference": "<string>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
localeId
string
required

The Id of the Locale

Required string length: 24

Response

Returns the Locale object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
name
string

The name of the Locale

Example:

"English"

​
primary
boolean
​
nluLanguage
enum<string>
Available options:
ge-GE,
da-DK,
en-AU,
en-CA,
en-IN,
en-GB,
en-US,
de-DE,
ja-JP,
ko-KR,
es-ES,
nl-NL,
ar-AE,
fi-FI,
fr-FR,
it-IT,
nn-NO,
pl-PL,
sv-SE,
th-TH,
zh-CN,
vi-VN,
pt-BR,
ru-RU,
pt-PT,
tr-TR,
hi-IN,
bn-IN,
ta-IN
Example:

"en-US"

​
fallbackLocaleReference
string
Required string length: 24
​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24