This endpoint lets you retrieve all the different translations for a particular project, using its custom ID. For comprehensive guidance on retrieving segments by custom IDs, including how to filter and sort the results, see the Getting Segments by Custom ID guide.
Note
For detailed instructions on making requests and viewing responses directly on the platform, including sample responses, please refer to the 'Step-by-Step Guide to Making Requests Directly on the Platform' section in the Quick Start Guide.
Instructions
Ensure that your request includes the necessary headers. To test the request directly on the platform:
- Navigate to the HEADERS section below the Response Payload section.
- Enter the "Content-Type" header with the value "application/json".
- Include your "Authorization" token using either Basic Auth or JWT Access Token. For detailed instructions on obtaining these tokens, refer to the documentation on Obtaining your API key and company ID and Obtaining your JWT token.
- To test the functionality of your request with specific path and query parameters:
- Locate the input field designated for the
customIdparameter in the "PATH PARAMS" section, found under the "Response Payload" section. Enter your desired value forcustomIdin this input field.- Specify the
statusandtaskIdin the corresponding input fields located in the "QUERY PARAMS" section.
Sample Response
To see a sample response, click the "EXAMPLES" dropdown at the top-right of your screen.
Response Payload
The following fields are returned after a successful request:
| Parameter | Type | Description |
|---|---|---|
source.id | integer | Unique identifier for the source segment. |
source.customId | string | Custom identifier assigned to the source segment. |
source.content | string | Content of the source segment. |
source.notes | string | Notes related to the source segment. |
source.taskId | string | Task ID associated with the source segment. |
source.languageSpecificNotes | string | Language-specific notes for the source segment. |
translations[].id | integer | Unique identifier for each translation. |
translations[].languageId | integer | Identifier for the language of the translation. |
translations[].languageCode | string | Language code (e.g., "EN-US", "FR-FR") for the translation. |
translations[].content | string | Translated content of the segment. |
translations[].status | string | Status of the translation (e.g., "untranslated", "completed"). |
translations[].comments[] | object | Comments on the translation, including an identifier and the comment text. |