> For the complete documentation index, see [llms.txt](https://docs.api.intratool.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.api.intratool.de/api-reference/languages.md).

# Languages

## Introduction

`Languages` represent the available languages in the system. Each language can be activated or deactivated and is used for translations and localization throughout the application. Languages are managed by administrators and can be sorted for display purposes.

## Model Definition

**Attributes**

| Key           | Type      | Description                                                                                       |
| ------------- | --------- | ------------------------------------------------------------------------------------------------- |
| `id`          | `string`  | The unique identifier of the `Language` ([BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)). |
| `locale`      | `string`  | The language part used by the application locale.                                                 |
| `active`      | `boolean` | Whether the `Language` is active.                                                                 |
| `sort_number` | `integer` | The sort order for display.                                                                       |

**Available Languages**

The following language keys and names are available in the current API version.

| Key       | Name                  |
| --------- | --------------------- |
| `ar-SA`   | Arabic                |
| `bg-BG`   | Bulgarian             |
| `cs-CZ`   | Czech                 |
| `da-DK`   | Danish                |
| `de-DE`   | German                |
| `el-GR`   | Greek                 |
| `en-GB`   | English (UK)          |
| `en-US`   | English (US)          |
| `es-ES`   | Spanish               |
| `et-EE`   | Estonian              |
| `fi-FI`   | Finnish               |
| `fr-FR`   | French                |
| `he-IL`   | Hebrew                |
| `hu-HU`   | Hungarian             |
| `id-ID`   | Indonesian            |
| `it-IT`   | Italian               |
| `ja-JP`   | Japanese              |
| `ko-KR`   | Korean                |
| `lt-LT`   | Lithuanian            |
| `lv-LV`   | Latvian               |
| `nb-NO`   | Norwegian Bokmål      |
| `nl-NL`   | Dutch                 |
| `pl-PL`   | Polish                |
| `pt-BR`   | Portuguese (Brazil)   |
| `pt-PT`   | Portuguese (Portugal) |
| `ro-RO`   | Romanian              |
| `ru-RU`   | Russian               |
| `sk-SK`   | Slovak                |
| `sl-SI`   | Slovenian             |
| `sv-SE`   | Swedish               |
| `tr-TR`   | Turkish               |
| `uk-UA`   | Ukrainian             |
| `vi-VN`   | Vietnamese            |
| `zh-Hans` | Chinese (Simplified)  |
| `zh-Hant` | Chinese (Traditional) |

## List

List available `Languages`.

**Definition**

<mark style="color:green;">`GET`</mark> `/api/languages`

**Request Keys**

| Key       | Type      | Default    | Description                         |
| --------- | --------- | ---------- | ----------------------------------- |
| `selects` | `string`  | All fields | Comma-separated fields to return.   |
| `limit`   | `integer` | No limit   | Maximum number of active languages. |

**Example Request**

{% tabs %}
{% tab title="PHP" %}

```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/languages', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
```

{% endtab %}
{% endtabs %}

**Example Response**

```json
[
  {
    "id": "en-US",
    "locale": "en",
    "active": true,
    "sort_number": 8,
    "created_at": "2026-08-06 08:00:00",
    "updated_at": "2026-08-06 08:00:00"
  },
  {
    "id": "es-ES",
    "locale": "es",
    "active": true,
    "sort_number": 9,
    "created_at": "2026-08-06 08:00:00",
    "updated_at": "2026-08-06 08:05:00"
  }
]
```

## Show

Show one available `Language`.

**Definition**

<mark style="color:green;">`GET`</mark> `/api/languages/{language}`

**Route Parameters**

| Parameter  | Type     | Description         |
| ---------- | -------- | ------------------- |
| `language` | `string` | BCP 47 Language ID. |

**Request Keys**

| Key       | Type     | Default    | Description                       |
| --------- | -------- | ---------- | --------------------------------- |
| `selects` | `string` | All fields | Comma-separated fields to return. |

**Example Request**

{% tabs %}
{% tab title="PHP" %}

```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/languages/en-US', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
```

{% endtab %}
{% endtabs %}

**Example Response**

```json
{
  "id": "en-US",
  "locale": "en",
  "active": true,
  "sort_number": 8,
  "created_at": "2026-08-06 08:00:00",
  "updated_at": "2026-08-06 08:00:00"
}
```

## Admin: List

List all `Languages` in administration scope.

**Definition**

<mark style="color:green;">`GET`</mark> `/api/administration/languages`

**Request Keys**

| Key       | Type      | Default    | Description                                      |
| --------- | --------- | ---------- | ------------------------------------------------ |
| `selects` | `string`  | All fields | Comma-separated fields to return.                |
| `limit`   | `integer` | No limit   | Maximum number of active and inactive languages. |

**Example Request**

{% tabs %}
{% tab title="PHP" %}

```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/languages', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
```

{% endtab %}
{% endtabs %}

**Example Response**

```json
[
  {
    "id": "en-US",
    "locale": "en",
    "active": true,
    "sort_number": 8,
    "created_at": "2026-08-06 08:00:00",
    "updated_at": "2026-08-06 08:00:00"
  },
  {
    "id": "fr-FR",
    "locale": "fr",
    "active": false,
    "sort_number": 12,
    "created_at": "2026-08-06 08:00:00",
    "updated_at": "2026-08-06 08:10:00"
  }
]
```

## Admin: Show

Show one `Language` in administration scope.

**Definition**

<mark style="color:green;">`GET`</mark> `/api/administration/languages/{language}`

**Route Parameters**

| Parameter  | Type     | Description                                          |
| ---------- | -------- | ---------------------------------------------------- |
| `language` | `string` | BCP 47 Language ID; inactive languages are included. |

**Request Keys**

| Key       | Type     | Default    | Description                       |
| --------- | -------- | ---------- | --------------------------------- |
| `selects` | `string` | All fields | Comma-separated fields to return. |

**Example Request**

{% tabs %}
{% tab title="PHP" %}

```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/languages/en-US', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
```

{% endtab %}
{% endtabs %}

**Example Response**

```json
{
  "id": "en-US",
  "locale": "en",
  "active": true,
  "sort_number": 8,
  "created_at": "2026-08-06 08:00:00",
  "updated_at": "2026-08-06 08:00:00"
}
```

## Admin: Update

Update an existing `Language`.

**Definition**

<mark style="color:blue;">`PUT`</mark> `/api/administration/languages/{language}`

**Route Parameters**

| Parameter  | Type     | Description         |
| ---------- | -------- | ------------------- |
| `language` | `string` | BCP 47 Language ID. |

**Request Keys**

| Key           | Type      | Default       | Description                     |
| ------------- | --------- | ------------- | ------------------------------- |
| `active`      | `boolean` | Current value | Whether the Language is active. |
| `sort_number` | `integer` | Current value | Display order.                  |

**Example Request**

{% tabs %}
{% tab title="PHP" %}

```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/languages/en-US', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'active' => true,
        'sort_number' => 8
    ]
]);
```

{% endtab %}
{% endtabs %}

**Example Response**

```json
{
  "status": "success",
  "data": {
    "id": "en-US",
    "locale": "en",
    "active": true,
    "sort_number": 8,
    "created_at": "2026-08-06 08:00:00",
    "updated_at": "2026-08-06 11:30:00"
  }
}
```