v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Localizations

Endpoint to interact with localizations

Operations

GET/api/v2/localizationsPOST/api/v2/localizationsGET/api/v2/localizations/{id}DELETE/api/v2/localizations/{id}PATCH/api/v2/localizations/{id}POST/api/v2/localizations/{id}/duplicatePOST/api/v2/localizations/bulk-delete

---

Get localizations

GET

/api/v2/localizations

Returns a paginated list of settings localizations

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Localization list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/localizations

Playground

Authorization

bearerAuth

Samples

---

Create localization

POST

/api/v2/localizations

Create a new localization; missing phrase keys are filled with empty string

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Localization created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/localizations

Playground

Authorization

bearerAuth

Body

Samples

---

Get localization by ID

GET

/api/v2/localizations/{id}

Returns a single localization with phrases

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Localization ID

Type

integer

Required

Format

"int64"

Responses

Localization object with phrases

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/localizations/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete localization

DELETE

/api/v2/localizations/{id}

Soft-deletes a localization

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Localization ID

Type

integer

Required

Format

"int64"

Responses

Localization deleted successfully

DELETE

/api/v2/localizations/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update localization

PATCH

/api/v2/localizations/{id}

Partial update; only present fields and phrase keys are updated

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Localization ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Localization updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/localizations/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Duplicate localization

POST

/api/v2/localizations/{id}/duplicate

Creates a copy of the localization and all its phrases

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Source localization ID to copy

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Localization duplicated

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/localizations/{id}/duplicate

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple localizations

POST

/api/v2/localizations/bulk-delete

Deletes multiple localizations

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Localizations deleted successfully

POST

/api/v2/localizations/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI