languages

2 endpoints
GET/rest/languages

List languages

Returns a list of available languages.

Parameters
Query Parameters
name
Optional
string

Language name

name:contains
Optional
string

Language name. Search for results that contain the specified characters in this parameter.

symbol
Optional
string

Language symbol

orderBy
Optional
string[]

Sorting options

mode
Optional
string

Determines the detail level of the response body.

Responses

List of languages retrieved successfully.

id
integer

Language unique identifier

name
string

Display name of the language

symbol
string

Short symbol code identifying the language

ietf
string

IETF BCP 47 language tag used for locale identification, e.g. en-US

links
string[]

HATEOAS links associated with the entity

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/languages" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/languages"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": 1, "name": "English", "symbol": "en" }, { "id": 2, "name": "French", "symbol": "fr" } ] }
// Error - No Body
GET/rest/languages/{id}

Get a language

Returns the details of a specified language, including its name and symbol.

Parameters
Path Parameters
id
Required
integer

ID of the language to be retrieved

Responses

Language details retrieved successfully.

id
integer

Language unique identifier

name
string

Display name of the language

symbol
string

Short symbol code identifying the language

ietf
string

IETF BCP 47 language tag used for locale identification, e.g. en-US

links
string[]

HATEOAS links associated with the entity

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/languages/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

id = "VALUE"  # ID of the language to be retrieved

url = f"https://{{instance}}.kiteworks.com/rest/languages/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "id": 1, "name": "English", "symbol": "en" }
// Error - No Body
Previousinternal
NextldapGroups