Skip to content
On this page

Custom Translations

The Translations Object

id uuid
Primary key of the translations

key string
The translation key.

language string
The language of the translation.

value string
The translation value.

json
{
	"data": {
		"id": "c4346aa4-81a8-4885-b3a8-f647e4f6f769",
		"key": "Test",
		"language": "en-US",
		"value": "Test"
	}
}
{
	"data": {
		"id": "c4346aa4-81a8-4885-b3a8-f647e4f6f769",
		"key": "Test",
		"language": "en-US",
		"value": "Test"
	}
}

List Translations

List all translations that exist in Directus.

Request

Query Parameters

Supports all global query parameters.

Response

An array of up to limit translation objects. If no items are available, data will be an empty array.

Example

Retrieve a Translation

List an existing translation by primary key.

Request

Query Parameters

Supports all global query parameters.

Response

Returns the requested translation object.

Example

Create a Translation

Create a new translation.

Request

Query Parameters

Supports all global query parameters.

Request Body

A partial translation object.

Response

Returns the translation object for the created translation.

Example

Create Multiple Translations

Create multiple new translation.

Request

Query Parameters

Supports all global query parameters.

Request Body

An array of partial translation object.

Response

Returns the translation object for the created translation.

Example

Update a Translation

Update an existing translation.

Request

Query Parameters

Supports all global query parameters.

Request Body

A partial translation object.

Response

Returns the translation object for the updated translation.

Example

Update Multiple Translations

Update multiple existing translations.

Request

Query Parameters

Supports all global query parameters.

Request Body

keys Required
Array of primary keys of the translations you'd like to update.

data Required
Any of translation object's properties.

Response

Returns the translation objects for the updated translations.

Example

Delete a Translation

Delete an existing translation.

Request

Response

Empty body.

Example

Delete Multiple Translations

Delete multiple existing translations.

Request

Request Body

An array of translations primary keys

Response

Empty body.

Example