Localizations

Endpointhttps://api.idol.io/api/v2

List localizations

GET

https://api.idol.io/api/v2

/localizations

Retrieve all localizations with optional filtering

List localizations › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[language-id]

string

Filter by language ID

List localizations › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a localization

POST

https://api.idol.io/api/v2

/localizations

Create a new localization for a resource attribute

Create a localization › Request Body

object · required

Create a localization › Responses

Localization created successfully

object

object[]

Related resources included in the response

object

POST/localizations

curl --request POST \
  --url https://api.idol.io/api/v2/localizations \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "localizations",
    "attributes": {
      "localized-attribute": "name",
      "value": "Translated Name",
      "phonetic": "translated-name"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "1"
        }
      },
      "localizable": {
        "data": {
          "type": "products",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "localizations",
    "attributes": {
      "localized-attribute": "name",
      "value": "Translated Name",
      "phonetic": "translated-name"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "1"
        }
      },
      "localizable": {
        "data": {
          "type": "products",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get localization details

GET

https://api.idol.io/api/v2

/localizations/{id}

Retrieve details for a specific localization by ID

Get localization details › path Parameters

id

string · required

Resource ID

Get localization details › query Parameters

include

string

Comma-separated list of related resources to include

Get localization details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a localization

PUT

https://api.idol.io/api/v2

/localizations/{id}

Update an existing localization's attributes

Update a localization › path Parameters

id

string · required

Resource ID

Update a localization › Request Body

object · required

Update a localization › Responses

Localization updated successfully

object

object[]

Related resources included in the response

object

Delete a localization

DELETE

https://api.idol.io/api/v2

/localizations/{id}

Delete a localization by its ID

Delete a localization › path Parameters

id

string · required

Resource ID

Delete a localization › Responses

Localization deleted successfully

No data returned

Languages Product Types

Labelcamp API v2

Localizations

Endpointhttps://api.idol.io/api/v2

List localizations

GET

https://api.idol.io/api/v2

/localizations

Retrieve all localizations with optional filtering

List localizations › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[language-id]

string

Filter by language ID

List localizations › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a localization

POST

https://api.idol.io/api/v2

/localizations

Create a new localization for a resource attribute

Create a localization › Request Body

object · required

Create a localization › Responses

Localization created successfully

object

object[]

Related resources included in the response

object

POST/localizations

curl --request POST \
  --url https://api.idol.io/api/v2/localizations \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "localizations",
    "attributes": {
      "localized-attribute": "name",
      "value": "Translated Name",
      "phonetic": "translated-name"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "1"
        }
      },
      "localizable": {
        "data": {
          "type": "products",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "localizations",
    "attributes": {
      "localized-attribute": "name",
      "value": "Translated Name",
      "phonetic": "translated-name"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "1"
        }
      },
      "localizable": {
        "data": {
          "type": "products",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get localization details

GET

https://api.idol.io/api/v2

/localizations/{id}

Retrieve details for a specific localization by ID

Get localization details › path Parameters

id

string · required

Resource ID

Get localization details › query Parameters

include

string

Comma-separated list of related resources to include

Get localization details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a localization

PUT

https://api.idol.io/api/v2

/localizations/{id}

Update an existing localization's attributes

Update a localization › path Parameters

id

string · required

Resource ID

Update a localization › Request Body

object · required

Update a localization › Responses

Localization updated successfully

object

object[]

Related resources included in the response

object

Delete a localization

DELETE

https://api.idol.io/api/v2

/localizations/{id}

Delete a localization by its ID

Delete a localization › path Parameters

id

string · required

Resource ID

Delete a localization › Responses

Localization deleted successfully

No data returned

Languages Product Types