Get Segments by Project ID

This endpoint lets users get all the translations for a particular project, identified by its unique ID in TextUnited. For detailed instructions on how to fetch segments by Project ID, including how to filter and sort the results, refer to the Getting Segments by Project ID guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
ℹ️

Instructions

Ensure that your request includes the necessary headers. To test the request directly on the platform:

  1. Navigate to the HEADERS section below the Response Payload section.
  2. To test the functionality of your request with specific path and query parameters:
    • Locate the input field designated for the id parameter in the "PATH PARAMS" section, found under the "Response Payload" section. Enter your desired value for id in this input field.
    • Specify the status and taskId in the corresponding input fields located in the "QUERY PARAMS" section.
    • Execute the test directly on the platform by clicking the "Try It!" button at the top-right of your screen to start your request and view your response.
❗️

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:

ParameterTypeDescription
source.idintegerUnique identifier for the source segment.
source.customIdstringCustom identifier assigned to the source segment.
source.contentstringContent of the source segment.
source.notesstringNotes related to the source segment.
source.taskIdstringTask ID associated with the source segment.
source.languageSpecificNotesstringLanguage-specific notes for the source segment.
translations[].idintegerUnique identifier for each translation.
translations[].languageIdintegerIdentifier for the language of the translation.
translations[].languageCodestringLanguage code (e.g., "EN-US", "FR-FR") for the translation.
translations[].contentstringTranslated content of the segment.
translations[].statusstringStatus of the translation (e.g., "untranslated", "completed").
translations[].comments[]objectComments on the translation, including an identifier and the comment text.
Path Params
int32
required

The unique identifier for the project whose segments are to be retrieved. This parameter is mandatory for specifying the project.

Query Params
string

Filter segments by their status (untranslated, draft, automatic, pretranslated, translated, proofread). Omitting this parameter retrieves all segments. (e.g., "status=translated")

string

Optionally filter segments by the task they belong to using the task's ID.

Body Params
string
Headers
string

Used for authenticating requests with a JWT token obtained from the "Obtain JWT" endpoint. (e.g. Authorization: Bearer <your_api_token>)

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json