Localizations

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

LocalizationListResponse

LocalizationResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/localizations

curl https://api.idol.io/api/v2/localizations \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "localizations",
      "id": "id",
      "attributes": {
        "localized-attribute": "name",
        "value": "Nom traduit",
        "phonetic": "nom-traduit",
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "language": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "localizable": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        }
      },
      "links": {
        "self": "https://www.example.com/path/to/resource"
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Create a localization

POST

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

/localizations

Create a new localization for a resource attribute

Create a localization › Request Body

LocalizationCreateRequest

object · required

Create a localization › Responses

Localization created successfully

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/localizations

curl https://api.idol.io/api/v2/localizations \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --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"
        }
      }
    }
  }
}'

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

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

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

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/localizations/{id}

curl https://api.idol.io/api/v2/localizations/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

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

LocalizationUpdateRequest

object · required

Update a localization › Responses

Localization updated successfully

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

PUT/localizations/{id}

curl https://api.idol.io/api/v2/localizations/:id \
  --request PUT \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "localizations",
    "id": "1",
    "attributes": {
      "value": "Updated Translation",
      "phonetic": "updated-translation"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "localizations",
    "id": "1",
    "attributes": {
      "value": "Updated Translation",
      "phonetic": "updated-translation"
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

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

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

LocalizationListResponse

LocalizationResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/localizations

curl https://api.idol.io/api/v2/localizations \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "localizations",
      "id": "id",
      "attributes": {
        "localized-attribute": "name",
        "value": "Nom traduit",
        "phonetic": "nom-traduit",
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "language": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "localizable": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        }
      },
      "links": {
        "self": "https://www.example.com/path/to/resource"
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Create a localization

POST

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

/localizations

Create a new localization for a resource attribute

Create a localization › Request Body

LocalizationCreateRequest

object · required

Create a localization › Responses

Localization created successfully

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/localizations

curl https://api.idol.io/api/v2/localizations \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --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"
        }
      }
    }
  }
}'

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

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

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

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/localizations/{id}

curl https://api.idol.io/api/v2/localizations/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

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

LocalizationUpdateRequest

object · required

Update a localization › Responses

Localization updated successfully

LocalizationResponse

LocalizationResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

PUT/localizations/{id}

curl https://api.idol.io/api/v2/localizations/:id \
  --request PUT \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "localizations",
    "id": "1",
    "attributes": {
      "value": "Updated Translation",
      "phonetic": "updated-translation"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "localizations",
    "id": "1",
    "attributes": {
      "value": "Updated Translation",
      "phonetic": "updated-translation"
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "type": "localizations",
    "id": "id",
    "attributes": {
      "localized-attribute": "name",
      "value": "Nom traduit",
      "phonetic": "nom-traduit",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "localizable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

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